/lineage/manual
Create a new lineage object manually. Only one direction of the relationship needs to be created. The opposite direction of the lineage is automatically generated.
application/json
LineageCreateNewLineageManuallyRequest
| Property | Type | Required |
|---|---|---|
| direction | string | optional |
| to_entity | string | optional |
| from_entity | string | optional |
Created
Bad Request
Internal Server Error
POST /lineage/manual
/lineage/manual/{lineage_id}
Delete a lineage object by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| lineage_id | path | required | string | The ID of the lineage entry to delete. |
No Content
Not Found
Internal Server Error
DELETE /lineage/manual/{lineage_id}
/lineage/manual/{lineage_id}
Get a lineage object by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| lineage_id | path | required | string | The ID of the lineage entry to retrieve. |
OK
Not Found
Internal Server Error
GET /lineage/manual/{lineage_id}
/metric/metrics
Retrieve a list of metrics.
List of metrics.
Bad Request
Internal Server Error
GET /metric/metrics
/metric/metrics
Create a metric, and define the relevant columns for the metric. This endpoint will create the resource, but will not run it. See the metric/metrics/{metric_id}/execute endpoint to run the metric for the first time.
application/json
MetricsCreateNewMetricRequest
| Property | Type | Required |
|---|---|---|
| sql | string | required |
| time | string | optional |
| title | string | required |
| primary | string | optional |
| dimension | string | optional |
| description | string | optional |
| integration | string | required |
| scheduled_delta | integer | optional |
Metric created successfully
Bad request
POST /metric/metrics
/metric/metrics/{metric_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| metric_id | path | required | string | — |
Metric deleted successfully
Metric not found
DELETE /metric/metrics/{metric_id}
/metric/metrics/{metric_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| metric_id | path | required | string | — |
Metric retrieved successfully
Metric not found
GET /metric/metrics/{metric_id}
/metric/metrics/{metric_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| metric_id | path | required | string | — |
application/json
MetricsUpdateMetricByIdRequest
| Property | Type | Required |
|---|---|---|
| sql | string | optional |
| title | string | optional |
| description | string | optional |
| scheduled_delta | string | optional |
Metric updated successfully
Metric not found
PATCH /metric/metrics/{metric_id}
/metric/metrics/{metric_id}/execute
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| metric_id | path | required | string | — |
application/json
MetricsRunMetricExecutionRequest
Metric executed successfully
POST /metric/metrics/{metric_id}/execute
/monitors/incident/{incident_id}
This endpoint allows you to retrieve an incident by it’s ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| incident_id | path | required | string | The unique identifier of the incident |
Monitor retrieved successfully
Incident not found
Internal Server Error
GET /monitors/incident/{incident_id}
/monitors/incidents
This endpoint allows you to retrieve a list of all the incidents in your workspace.
List of Incidents.
Bad Request
Internal Server Error
GET /monitors/incidents
/monitors/measurements
This endpoint allows you to retrieve a list of all the measurements in your workspace filtered by a Monitor or Incident. A query param of either the Monitor ID or Incident ID is required.
If using monitoring in automatic mode, thresholds will take some time to populate as the system learnins the appropriate range for your data.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| monitor | query | optional | string | The unique identifier of the monitor |
| incident_id | query | optional | string | The unique identifier of the incident |
List of Measurements.
Bad Request
Internal Server Error
GET /monitors/measurements
/monitors/monitors
This endpoint allows you to retrieve a list of all the monitors in your workspace.
List of Monitors.
Bad Request
Internal Server Error
GET /monitors/monitors
/monitors/monitors/{monitor_id}
This endpoint allows you to retrieve a monitors by it’s ID. You can find the ID in the URL of the monitor when accessing it from the Secoda UI.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| monitor_id | path | required | string | The unique identifier of the monitor |
Monitor retrieved successfully
Monitor not found
Internal Server Error
GET /monitors/monitors/{monitor_id}
/query/queries
This endpoint allows you to retrieve a list of all queries in the workspace. No filtering is available at this time.
List of queries.
Bad Request
Internal Server Error
GET /query/queries
/query/queries/{query_id}
This endpoint allows you to retrieve a query by its unique identifier (query_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| query_id | path | required | string | The unique identifier of the query |
Query retrieved successfully
Query not found
Internal Server Error
GET /query/queries/{query_id}
/question/questions
This endpoint allows you to retrieve a list of questions.
List of questions.
Bad Request
Internal Server Error
GET /question/questions
/question/questions
This endpoint allows you to create a new question. The answer to the question can be set in the answer field, or added as a reply to the question/replies endpoint.
application/json
BaseResourceRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| title | string | optional |
| owners | array | optional |
| parent | string | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| integration | string | optional |
| subscribers | array | optional |
Created
Bad Request
Internal Server Error
POST /question/questions
/question/questions/{question_id}
This endpoint allows you to delete a question by its unique identifier (question_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| question_id | path | required | string | The unique identifier of the question to delete |
Question deleted successfully
Question not found
Internal Server Error
DELETE /question/questions/{question_id}
/question/questions/{question_id}
This endpoint allows you to retrieve a question by its unique identifier (question_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| question_id | path | required | string | The unique identifier of the question |
Question retrieved successfully
Question not found
Internal Server Error
GET /question/questions/{question_id}
/question/questions/{question_id}
This endpoint allows you to edit the metadata of a question by its unique identifier (question_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| question_id | path | required | string | The unique identifier of the question to edit |
application/json
BasePatchRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| owners | array | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| subscribers | array | optional |
Definition updated successfully
Bad Request
Question not found
Internal Server Error
PATCH /question/questions/{question_id}
/question/replies
This endpoint allows you to retrieve a list of replies. You can optionally filter the replies by question_id using the “question_id” query parameter.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| question_id | query | optional | string | Filter replies by question_id (optional) |
List of replies.
Bad Request
Internal Server Error
GET /question/replies
/question/replies
This endpoint allows you to create a new reply to a specified question (indicated by the parent_id).
application/json
QuestionsCreateNewReplyRequest
| Property | Type | Required |
|---|---|---|
| owners | array | optional |
| parent | string | optional |
| definition | string | optional |
| accepted_answer | boolean | optional |
Created
Bad Request
Internal Server Error
POST /question/replies
/question/replies/{reply_id}
This endpoint allows you to delete a reply by its unique identifier (reply_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| reply_id | path | required | string | The unique identifier of the reply to delete |
Reply deleted successfully
Reply not found
Internal Server Error
DELETE /question/replies/{reply_id}
/question/replies/{reply_id}
This endpoint allows you to retrieve a reply by its unique identifier (reply_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| reply_id | path | required | string | The unique identifier of the reply |
Reply retrieved successfully
Reply not found
Internal Server Error
GET /question/replies/{reply_id}
/question/replies/{reply_id}
This endpoint allows you to edit the content of a reply by its unique identifier (reply_id). You can also use this endoint to set this reply as the accepted answer.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| reply_id | path | required | string | The unique identifier of the reply to edit |
application/json
QuestionsEditReplyByIdRequest
| Property | Type | Required |
|---|---|---|
| definition | string | optional |
| accepted_answer | boolean | optional |
Definition updated successfully
Bad Request
Reply not found
Internal Server Error
PATCH /question/replies/{reply_id}
/table/schemas
Endpoint for retrieving a list of schemas with optional filtering by parent schema and title.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| parent | query | optional | string | The ID of the parent database to filter by. |
| title | query | optional | string | The title of the schema to filter by. |
List of schemas.
Bad request.
Internal server error.
GET /table/schemas
/table/schemas
Create a new schema. Schema must have one database as a parent, and be associated with an integration.
application/json
BaseResourceRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| title | string | optional |
| owners | array | optional |
| parent | string | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| integration | string | optional |
| subscribers | array | optional |
Schema created successfully
Bad request.
Internal server error.
POST /table/schemas
/table/schemas/{schema_id}
Retrieve schema details by its unique ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| schema_id | path | required | string | The ID of the schema to retrieve or update. |
Schema details retrieved successfully
Schema not found.
Internal server error.
GET /table/schemas/{schema_id}
/table/schemas/{schema_id}
Use this endpoint to update schema metadata.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| schema_id | path | required | string | The ID of the schema to retrieve or update. |
application/json
BasePatchRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| owners | array | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| subscribers | array | optional |
Schema updated successfully
Bad request.
Schema not found.
Internal server error.
PATCH /table/schemas/{schema_id}
/table/tables
This endpoint retrieves a list of tables, with optional filters for the integration, the schema, and the title of the table resource.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| integration_id | query | optional | string | Integration ID |
| parent_id | query | optional | string | ID of the schema |
| title | query | optional | string | Title of the table |
List of databases.
Bad request.
Internal server error.
GET /table/tables
/table/tables
Create a new table with a schema as a parent. The table must be associated with an integration.
application/json
BaseResourceRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| title | string | optional |
| owners | array | optional |
| parent | string | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| integration | string | optional |
| subscribers | array | optional |
Table created successfully
Bad request.
Internal server error.
POST /table/tables
/table/tables/{table_id}
This endpoint deletes a specific table by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| table_id | path | required | string | ID of the table to delete |
Table deleted successfully
Table not found.
Internal server error.
DELETE /table/tables/{table_id}
/table/tables/{table_id}
This endpoint retrieves a specific table by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| table_id | path | required | string | ID of the table to retrieve |
Successful response
Table not found.
Internal server error.
GET /table/tables/{table_id}
/table/tables/{table_id}
Use this endpoint to update table metadata.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| table_id | path | required | string | ID of the table to update |
Table data to update
application/json
BasePatchRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| owners | array | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| subscribers | array | optional |
Successful response
Bad request.
Table not found.
Internal server error.
PATCH /table/tables/{table_id}
/tag
Get a list of tags. No filtering is currently available.
List of tags.
Bad Request
Internal Server Error
GET /tag
/tag
Create a new tag for the workspace.
application/json
TagsCreateNewTagRequest
| Property | Type | Required |
|---|---|---|
| name | string | optional |
| color | string | optional |
| description | string | optional |
Created
Bad Request
Internal Server Error
POST /tag
/tag/{tag_id}
Delete a tag by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tag_id | path | required | string | The ID of the tag to delete. |
No Content
Not Found
Internal Server Error
DELETE /tag/{tag_id}
/tag/{tag_id}
Get a tag by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tag_id | path | required | string | The ID of the tag to retrieve. |
OK
Not Found
Internal Server Error
GET /tag/{tag_id}
/tag/{tag_id}
Use this endpoint to update tag name, color, or icon.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tag_id | path | required | string | The ID of the tag to update. |
application/json
TagsUpdateByIdRequest
| Property | Type | Required |
|---|---|---|
| color | string | required |
No Content
Not Found
Internal Server Error
PATCH /tag/{tag_id}
/auth/teams
Get a list of teams in the workspace.
List of teams.
Bad Request
Internal Server Error
GET /auth/teams
/auth/teams
Create a new team in the workspace.
application/json
TeamsCreateNewTeamRequest
| Property | Type | Required |
|---|---|---|
| icon | string | optional |
| name | string | optional |
| type | string | optional |
| description | string | optional |
| sidebar_settings | object | optional |
| └ home | boolean | optional |
| └ catalog | boolean | optional |
| └ documents | boolean | optional |
| └ questions | boolean | optional |
| └ dictionary | boolean | optional |
| └ collections | boolean | optional |
Created
Bad Request
Internal Server Error
POST /auth/teams
/auth/teams/{id}
Delete a team by their ID. Any resources that belong solely to this team will be set to the default team.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The ID of the team to delete. |
No Content
Not Found
Internal Server Error
DELETE /auth/teams/{id}
/auth/teams/{id}
Get a team by their ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The ID of the team to retrieve. |
OK
Not Found
Internal Server Error
GET /auth/teams/{id}
/auth/teams/{id}
Use this endpoint to update the Team. Editable fields include the name, description, icon, type, and sidebar settings.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The ID of the team to update. |
application/json
TeamsUpdateByIdRequest
| Property | Type | Required |
|---|---|---|
| name | string | optional |
Team updated successfully
Bad Request
User not found
Internal Server Error
PATCH /auth/teams/{id}
/dictionary/terms
This endpoint allows you to retrieve a list of dictionary terms with optional filtering by name of the term (title).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| title | query | optional | string | Filter terms by title (optional) |
List of dictionary terms.
Bad Request
Internal Server Error
GET /dictionary/terms
/dictionary/terms
This endpoint allows you to create a new dictionary term with the specified data. The title will map to the dictionary term name, and the definition of the term can be added to the definition field.
application/json
BaseResourceRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| title | string | optional |
| owners | array | optional |
| parent | string | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| integration | string | optional |
| subscribers | array | optional |
Created
Bad Request
Internal Server Error
POST /dictionary/terms
/dictionary/terms/{term_id}
This endpoint allows you to delete a dictionary term by its unique identifier (term_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| term_id | path | required | string | The unique identifier of the dictionary term to delete |
Term deleted successfully
Term not found
Internal Server Error
DELETE /dictionary/terms/{term_id}
/dictionary/terms/{term_id}
This endpoint allows you to retrieve a single dictionary term by its unique identifier (term_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| term_id | path | required | string | The unique identifier of the dictionary term |
Dictionary term retrieved successfully
Term not found
Internal Server Error
GET /dictionary/terms/{term_id}
/dictionary/terms/{term_id}
This endpoint allows you to edit the metadata of a dictionary term by its unique identifier (term_id).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| term_id | path | required | string | The unique identifier of the dictionary term to edit |
application/json
BasePatchRequest
| Property | Type | Required |
|---|---|---|
| pii | boolean | optional |
| tags | array | optional |
| teams | array | optional |
| owners | array | optional |
| verified | boolean | optional |
| published | boolean | optional |
| definition | string | optional |
| properties | object | optional |
| └ custom | array | optional |
| └ name | string | optional |
| └ type | string | optional |
| └ order | integer | optional |
| └ value | string | optional |
| collections | array | optional |
| description | string | optional |
| subscribers | array | optional |
Description updated successfully
Bad Request
Term not found
Internal Server Error
PATCH /dictionary/terms/{term_id}