Download OpenAPI specification:Download
The DataOps Observability Platform API.
WARNING: This is an internal API and is subject to unannounced breaking changes.
Lists all agents for the project using the specified project ID.
project_id required | string the ID of the project being queried. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the agent list. The sort is applied to the list before pagination. |
search | string Optional. A case-insensitive search query. If specified, only agent keys or tool names with a partial or full match to the query will be listed. |
{- "entities": [
- {
- "latest_event_timestamp": "2019-08-24T14:15:22Z",
- "tool": "string",
- "project": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "version": "string",
- "key": "string",
- "latest_heartbeat": "2019-08-24T14:15:22Z"
}
], - "total": 0
}
Retrieves the URL for SSO authentication so the app can redirect users. Warning - This endpoint is not intended for use by end users.
state | string Default: "" CSRF token generated by the system for this user session. |
redirect_url | string Default: "request.base_url" Page to redirect user to after successful SSO login |
{- "login_url": "string"
}
Login to the observability tool using OpenID authentication method. A JWT token that should be used to authenticate subsequent requests will be returned when the endpoint succeeds. This endpoint is not intended for use by end users.
Data required to generate a new valid JWT.
redirect_url | string <url> |
code required | string |
state | string Default: "" |
{- "redirect_url": "string",
- "code": "string",
- "state": ""
}
{- "error": "An error message.",
- "details": {
- "key": "value"
}
}
Login to the observability tool using basic authentication method. A JWT token that should be used to authenticate subsequent requests will be returned when the endpoint succeeds. This endpoint is not intended for use by end users.
{- "error": "An error message.",
- "details": {
- "key": "value"
}
}
Lists all companies in the system.
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the company list. The sort is applied to the list before pagination. |
{- "entities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_on": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "total": 0
}
Creates a new company using the specified name.
The data required to create the new Company and Authentication Provider.
name required | string <= 255 characters |
{- "name": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_on": "2019-08-24T14:15:22Z",
- "name": "string"
}
Updates attributes for a single company. Use this request to change a company name or set its status to active or inactive.
company_id required | string |
The new data for the company.
name required | string <= 255 characters |
{- "name": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_on": "2019-08-24T14:15:22Z",
- "name": "string"
}
Retrieves a single company by its ID.
company_id required | string |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "created_on": "2019-08-24T14:15:22Z",
- "name": "string"
}
List all instances of a journey.
project_id required | string the ID of the project being queried. |
journey_id | Array of strings <uuid> Optional. Specifies which journeys to include by their ID. All journeys are selected if unset. |
active | boolean Optional. When true, instances without a reported end_time are returned i.e., uncompleted instances. When active is false, instances with a reported end_time are returned i.e., completed instances. Leave this query unspecified to return instances with both states. Cannot be specified with end_range_begin or end_range_end. |
start_range_begin | string <date> Optional. An ISO8601 datetime. If specified, The result will only include instances with a start_time field equal or past the given datetime. May be specified with start_range_end to create a range. |
start_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain instances with a start_time field before the given datetime. May be specified with start_range_begin to create a range. |
end_range_begin | string <date> Optional. An ISO8601 datetime. If specified, The result will only include instances with an end_time field equal or past the given datetime. May be specified with end_range_end to create a range. |
end_range_end | string <date> Optional. An ISO8601 datetime. If specified, The result will only include instances with an end_time field before the given datetime. May be specified with end_range_begin to create a range. |
journey_name | Array of strings Optional. If specified, the results will be limited to instances with the journeys named. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the instance list. |
search | string Optional. A case-insensitive search query. If specified, only instances with payload key value that is a partial or full match to the query will be listed. |
{- "entities": [
- {
- "alerts_summary": [
- {
- "level": "WARNING",
- "description": "string",
- "count": 0
}
], - "active": true,
- "status": "ERROR",
- "payload_key": "string",
- "tests_summary": [
- {
- "count": 0,
- "status": "PASSED"
}
], - "expected_end_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "runs_summary": [
- {
- "count": 0,
- "status": "string"
}
], - "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}, - "start_type": "BATCH",
- "end_time": "2019-08-24T14:15:22Z"
}
], - "total": 0
}
Retrieves a single instance by its ID.
instance_id required | string |
{- "alerts_summary": [
- {
- "level": "WARNING",
- "description": "string",
- "count": 0
}
], - "active": true,
- "status": "ERROR",
- "payload_key": "string",
- "tests_summary": [
- {
- "count": 0,
- "status": "PASSED"
}
], - "expected_end_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "runs_summary": [
- {
- "count": 0,
- "status": "string"
}
], - "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}, - "start_type": "BATCH",
- "end_time": "2019-08-24T14:15:22Z"
}
List all instances in the company.
project_id | Array of strings <uuid> Optional. Specifies the project IDs to include. All projects are selected if unset. |
journey_id | Array of strings <uuid> Optional. Specifies which journeys to include by their ID. All journeys are selected if unset. |
active | boolean Optional. When true, instances without a reported end_time are returned i.e., uncompleted instances. When active is false, instances with a reported end_time are returned i.e., completed instances. Leave this query unspecified to return instances with both states. Cannot be specified with end_range_begin or end_range_end. |
start_range_begin | string <date> Optional. An ISO8601 datetime. If specified, The result will only include instances with a start_time field equal or past the given datetime. May be specified with start_range_end to create a range. |
start_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain instances with a start_time field before the given datetime. May be specified with start_range_begin to create a range. |
end_range_begin | string <date> Optional. An ISO8601 datetime. If specified, The result will only include instances with an end_time field equal or past the given datetime. May be specified with end_range_end to create a range. |
end_range_end | string <date> Optional. An ISO8601 datetime. If specified, The result will only include instances with an end_time field before the given datetime. May be specified with end_range_begin to create a range. |
journey_name | Array of strings Optional. If specified, the results will be limited to instances with the journeys named. |
status | Array of strings Optional. If specified, the results will be limited to instances with the specified statuses. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the instance list. |
search | string Optional. A case-insensitive search query. If specified, only instances with payload key value that is a partial or full match to the query will be listed. |
{- "entities": [
- {
- "alerts_summary": [
- {
- "level": "WARNING",
- "description": "string",
- "count": 0
}
], - "active": true,
- "status": "ERROR",
- "payload_key": "string",
- "tests_summary": [
- {
- "count": 0,
- "status": "PASSED"
}
], - "expected_end_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "runs_summary": [
- {
- "count": 0,
- "status": "string"
}
], - "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}, - "start_type": "BATCH",
- "end_time": "2019-08-24T14:15:22Z"
}
], - "total": 0
}
List all instances of a journey.
project_id required | string the ID of the project being queried. |
Search parameters payload
object |
{- "params": {
- "journey_id": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "active": true,
- "start_range_begin": "2019-08-24",
- "start_range_end": "2019-08-24",
- "end_range_begin": "2019-08-24",
- "end_range_end": "2019-08-24",
- "journey_name": [
- "string"
], - "page": 1,
- "count": 10,
- "sort": "ASC",
- "search": "string"
}
}
{- "entities": [
- {
- "alerts_summary": [
- {
- "level": "WARNING",
- "description": "string",
- "count": 0
}
], - "active": true,
- "status": "ERROR",
- "payload_key": "string",
- "tests_summary": [
- {
- "count": 0,
- "status": "PASSED"
}
], - "expected_end_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "runs_summary": [
- {
- "count": 0,
- "status": "string"
}
], - "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}, - "start_type": "BATCH",
- "end_time": "2019-08-24T14:15:22Z"
}
], - "total": 0
}
Creates a new instance rule in a journey.
journey_id required | string The ID of the journey that the instance rule will be created under. |
The data required for the new instance rule.
action required | string Enum: "START" "END" "END_PAYLOAD" Required. The selected action to perform when the rule's condition is satisfied. |
object (ScheduleInstanceRule) | |
batch_pipeline | string <uuid> |
{- "action": "START",
- "schedule": {
- "expression": "15 * * * 1,3,5",
- "timezone": "America/Sao_Paulo"
}, - "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed"
}
{- "action": "START",
- "schedule": {
- "expression": "15 * * * 1,3,5",
- "timezone": "America/Sao_Paulo"
}, - "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
Lists all journeys for the project using the specified project ID.
project_id required | string the ID of the project being queried. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the journey list. The sort is applied to the list before pagination. |
search | string Optional. A case-insensitive search query. If specified, only journey names with a partial or full match to the query will be listed. |
component_id | string <uuid> Optional. A component ID. If specified, only journeys in the given component will be listed. |
{- "entities": [
- {
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "instance_rules": [
- {
- "action": "START",
- "schedule": {
- "expression": "15 * * * 1,3,5",
- "timezone": "America/Sao_Paulo"
}, - "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}
], - "total": 0
}
Creates a new journey in a project using the specified name and project ID.
project_id required | string The ID of the project that the journey will be created under. |
The data required for the new journey.
description | string or null <= 255 characters Default: null |
name | string or null <= 255 characters Default: null |
{- "description": null,
- "name": null
}
{- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "instance_rules": [
- {
- "action": "START",
- "schedule": {
- "expression": "15 * * * 1,3,5",
- "timezone": "America/Sao_Paulo"
}, - "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}
Updates attributes for a single journey. Use this request to change a journey name and description
journey_id required | string |
The update data for the journey.
description | string or null |
name | string or null |
{- "description": "string",
- "name": "string"
}
{- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "instance_rules": [
- {
- "action": "START",
- "schedule": {
- "expression": "15 * * * 1,3,5",
- "timezone": "America/Sao_Paulo"
}, - "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}
Retrieves a single journey by its ID.
journey_id required | string |
{- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "instance_rules": [
- {
- "action": "START",
- "schedule": {
- "expression": "15 * * * 1,3,5",
- "timezone": "America/Sao_Paulo"
}, - "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}
Retrieves the DAG by the ID of it's journey.
journey_id required | string |
{- "nodes": [
- {
- "edges": [
- {
- "id": "string",
- "component": "593c6441-422a-4835-83e3-e0651f631fef"
}
], - "component": {
- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
}
]
}
Creates a new DAG edge for a Journey.
journey_id required | string The ID of the Journey that the DAG edge will be created under. |
The data required for the new DAG edge.
{ }
{- "left": "022cd5fc-3f5c-4d6d-89e8-e877d6d1ad13",
- "right": "a4e90aa1-5aef-4eb1-8681-fc980d6cdf85"
}
Lists all organizations in a company using the specified company ID.
company_id required | string the ID of the requested company. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the organization list. The sort is applied to the list before pagination. |
{- "entities": [
- {
- "company": "87340f10-f684-4b06-8427-5981380bd9a9",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "total": 0
}
Creates a new organization in a company using the specified name and company ID.
company_id required | string the ID of the requested company. |
The data required for the new organization.
description | string or null <= 255 characters Default: null |
name required | string <= 255 characters |
{- "description": null,
- "name": "string"
}
{- "company": "87340f10-f684-4b06-8427-5981380bd9a9",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Updates attributes for a single organization. Use this request to change an organization name and description.
organization_id required | string |
The new data for the organization.
description | string or null <= 255 characters Default: null |
name required | string <= 255 characters |
{- "description": null,
- "name": "string"
}
{- "company": "87340f10-f684-4b06-8427-5981380bd9a9",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Retrieves a single organization by its ID.
organization_id required | string |
{- "company": "87340f10-f684-4b06-8427-5981380bd9a9",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Lists all projects in an organization using the specified organization ID.
organization_id required | string The ID of organization being queried for projects. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the organization list. The sort is applied to the list before pagination. |
search | string Optional. A case-insensitive search query. If specified, only project names with a partial or full match to the query will be listed. |
{- "entities": [
- {
- "active": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "total": 0
}
Creates a new project in an organization using the specified name and organization ID.
organization_id required | string The ID of organization that the project will be created under. |
The data required for the new project.
active | boolean Default: true |
description | string or null <= 255 characters Default: null |
name required | string <= 255 characters |
{- "active": true,
- "description": null,
- "name": "string"
}
{- "active": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Updates attributes for a single project. Use this request to change a project name and description or set its status to active or inactive.
project_id required | string |
The update data for the project.
active | boolean Default: true |
description | string or null <= 255 characters Default: null |
name required | string <= 255 characters |
{- "active": true,
- "description": null,
- "name": "string"
}
{- "active": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Retrieves a single project by its ID.
project_id required | string |
{- "active": true,
- "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
- "description": null,
- "created_on": "2019-08-24T14:15:22Z",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Retrieves events by project_id.
project_id required | string |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the event list. The sort is applied to the list before pagination. |
count | integer Default: 10 The number of results to display per page. |
event_id | Array of strings Optional. If specified, the results will be limited to events with the given IDs. |
journey_id | Array of strings Optional. If specified, the results will be limited to events with one of the given journey IDs. |
component_id | Array of strings Optional. If specified, the results will be limited to events with one of the given component IDs. |
run_id | Array of strings Optional. If specified, the results will be limited to events with one of the specified run IDs. |
instance_id | Array of strings Optional. If specified, the results will be limited to events with one of the specified instance IDs. |
task_id | Array of strings Optional. If specified, the results will be limited to events with one of the specified task IDs. |
date_range_start | string <date> Optional. An ISO8601 datetime. If specified, The result will only include events with an event_timestamp field equal or past the given datetime. May be specified with date_range_end to create a range. |
date_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain events with an event_timestamp field before the given datetime. May be specified with date_range_start to create a range. |
event_type | Array of strings Items Enum: "BATCH_PIPELINE_STATUS" "DATASET_OPERATION" "MESSAGE_LOG" "METRIC_LOG" "TEST_OUTCOMES" Optional. If specified, the results will be limited to events with one of the specified event types. |
{- "entities": [
- {
- "run": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "timestamp": "2019-08-24T14:15:22Z",
- "task": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "display_name": "string"
}, - "run_task": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "event_type": "BATCH_PIPELINE_STATUS",
- "instances": [
- {
- "instance": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
], - "raw_data": { },
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "version": 1,
- "received_timestamp": "2019-08-24T14:15:22Z",
- "components": [
- {
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "display_name": "string",
- "tool": null,
- "type": "BATCH_PIPELINE"
}
]
}
], - "total": 0
}
Retrieves alerts by project_id.
project_id required | string |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the alerts list. The sort is applied to the list before pagination. |
count | integer Default: 10 The number of results to display per page. |
instance_id | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified instance IDs. |
run_id | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified run IDs. |
run_key | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified run keys. |
level | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified levels. |
type | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified alert types. |
component_id | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified component IDs. In case of run alerts, the component ID is the run's pipeline ID. |
date_range_start | string <date> Optional. An ISO8601 datetime. If specified, The result will only include alerts created on the same or after the given datetime. May be specified with date_range_end to create a range. |
date_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain alerts created on before the given datetime. May be specified with date_range_start to create a range. |
{- "details": { },
- "run": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "name": "string"
}, - "type": "MISSING_RUN",
- "created_on": "2019-08-24T14:15:22Z",
- "description": "string",
- "level": "WARNING",
- "instance": "868cf2e9-bd6d-4bac-96ba-2b08120d8cf9",
- "components": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "BATCH_PIPELINE",
- "tool": null,
- "display_name": "string"
}
]
}
Retrieves events by project_id.
project_id required | string |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the event list. The sort is applied to the list before pagination. |
count | integer Default: 10 The number of results to display per page. |
event_id | Array of strings Optional. If specified, the results will be limited to events with the given IDs. |
journey_id | Array of strings Optional. If specified, the results will be limited to events with one of the given journey IDs. |
component_id | Array of strings Optional. If specified, the results will be limited to events with one of the given component IDs. |
run_id | Array of strings Optional. If specified, the results will be limited to events with one of the specified run IDs. |
instance_id | Array of strings Optional. If specified, the results will be limited to events with one of the specified instance IDs. |
task_id | Array of strings Optional. If specified, the results will be limited to events with one of the specified task IDs. |
date_range_start | string <date> Optional. An ISO8601 datetime. If specified, The result will only include events with an event_timestamp field equal or past the given datetime. May be specified with date_range_end to create a range. |
date_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain events with an event_timestamp field before the given datetime. May be specified with date_range_start to create a range. |
event_type | Array of strings Items Enum: "BATCH_PIPELINE_STATUS" "DATASET_OPERATION" "MESSAGE_LOG" "METRIC_LOG" "TEST_OUTCOMES" Optional. If specified, the results will be limited to events with one of the specified event types. |
{- "entities": [
- {
- "run": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "timestamp": "2019-08-24T14:15:22Z",
- "task": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "display_name": "string"
}, - "run_task": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "event_type": "BATCH_PIPELINE_STATUS",
- "instances": [
- {
- "instance": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
], - "raw_data": { },
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "version": 1,
- "received_timestamp": "2019-08-24T14:15:22Z",
- "components": [
- {
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "display_name": "string",
- "tool": null,
- "type": "BATCH_PIPELINE"
}
]
}
], - "total": 0
}
List all test outcomes in a project.
project_id required | string the ID of the project being queried. |
component_id | Array of strings <uuid> Optional. If specified, the results will be limited to test outcomes that belong to one of the given component IDs. |
status | Array of strings Optional. If specified, the results will be limited to test outcomes that have to one of the given statuses. |
start_range_begin | string <date> Optional. An ISO8601 datetime. If specified, the result will only include test outcomes with a start_time field equal or past the given datetime. May be specified with start_range_end to create a range. |
start_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain test outcomes with a start_time field before the given datetime. May be specified with start_range_begin to create a range. |
end_range_begin | string <date> Optional. An ISO8601 datetime. If specified, the result will only include test outcomes with an end_time field equal or past the given datetime. May be specified with end_range_end to create a range. |
end_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only include test outcomes with an end_time field before the given datetime. May be specified with end_range_begin to create a range. |
instance_id | string <uuid> Optional. The ID of the Instance to filter against. If specified, the result will only include test outcomes related to the given Instance. |
run_id | string <uuid> Optional. The ID of the Run to filter against. If specified, the result will only include test outcomes related to the given Run. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the test outcomes list. |
search | string Optional. A case-insensitive search query. If specified, test outcomes with names or descriptions that have a partial or full match to the query will be listed. |
key | string <uuid> Optional. The key of the TestOutcome to filter against. If specified, the result will only include test outcomes which share the same key value. |
{- "entities": [
- {
- "start_time": "2019-08-24T14:15:22Z",
- "result": null,
- "updated_on": "string",
- "task": null,
- "metric_name": null,
- "name": "string",
- "external_url": null,
- "end_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "metric_description": null,
- "description": null,
- "dimensions": [
- "string"
], - "max_threshold": 6.28,
- "key": null,
- "run": null,
- "integrations": [
- {
- "test_outcome": null,
- "integration_name": "string",
- "table": "string",
- "columns": [
- "string"
], - "test_suite": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "version": 0,
- "test_parameters": [
- {
- "value": null,
- "name": "string"
}
]
}
], - "type": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "component": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "BATCH_PIPELINE",
- "tool": null,
- "display_name": "string"
}, - "metric_value": 10.22,
- "min_threshold": 3.14,
- "instance_set": null
}
], - "total": 0
}
Retrieves a single test outcome by its ID.
test_outcome_id required | string |
{- "start_time": "2019-08-24T14:15:22Z",
- "result": null,
- "updated_on": "string",
- "task": null,
- "metric_name": null,
- "name": "string",
- "external_url": null,
- "end_time": "2019-08-24T14:15:22Z",
- "status": "string",
- "metric_description": null,
- "description": null,
- "dimensions": [
- "string"
], - "max_threshold": 6.28,
- "key": null,
- "run": null,
- "integrations": [
- {
- "test_outcome": null,
- "integration_name": "string",
- "table": "string",
- "columns": [
- "string"
], - "test_suite": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "version": 0,
- "test_parameters": [
- {
- "value": null,
- "name": "string"
}
]
}
], - "type": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "component": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "BATCH_PIPELINE",
- "tool": null,
- "display_name": "string"
}, - "metric_value": 10.22,
- "min_threshold": 3.14,
- "instance_set": null
}
Retrieves alerts by project_id.
project_id required | string |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the alerts list. The sort is applied to the list before pagination. |
count | integer Default: 10 The number of results to display per page. |
instance_id | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified instance IDs. |
run_id | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified run IDs. |
run_key | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified run keys. |
level | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified levels. |
type | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified alert types. |
component_id | Array of strings Optional. If specified, the results will be limited to alerts with one of the specified component IDs. In case of run alerts, the component ID is the run's pipeline ID. |
date_range_start | string <date> Optional. An ISO8601 datetime. If specified, The result will only include alerts created on the same or after the given datetime. May be specified with date_range_end to create a range. |
date_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain alerts created on before the given datetime. May be specified with date_range_start to create a range. |
{- "details": { },
- "run": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "name": "string"
}, - "type": "MISSING_RUN",
- "created_on": "2019-08-24T14:15:22Z",
- "description": "string",
- "level": "WARNING",
- "instance": "868cf2e9-bd6d-4bac-96ba-2b08120d8cf9",
- "components": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "BATCH_PIPELINE",
- "tool": null,
- "display_name": "string"
}
]
}
List all available roles.
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the role list. The sort is applied to the list before pagination. |
{- "entities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": null,
- "name": "string"
}
], - "total": 0
}
Creates a new using the specified name and description.
The data for the new Role
description | string or null <= 255 characters Default: null |
name required | string <= 255 characters |
{- "description": null,
- "name": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": null,
- "name": "string"
}
Updates attributes for a single role. Use this request to change a role name or description.
role_id required | string |
The update data for the role.
description | string or null <= 255 characters Default: null |
name required | string <= 255 characters |
{- "description": null,
- "name": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": null,
- "name": "string"
}
List all rules that attached to a journey.
journey_id required | string the ID of the journey being queried. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the rules list. The sort is applied to the list before pagination. |
{- "entities": [
- {
- "rule_data": { },
- "component": null,
- "created_on": "2019-08-24T14:15:22Z",
- "action_args": {
- "template": "NotifyTemplate",
- "recipients": [
- "user@example.com"
]
}, - "action": "SEND_EMAIL",
- "rule_schema": "string",
- "updated_on": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
], - "total": 0
}
Creates a new rule associated with a Journey.
journey_id required | string The ID of journey that the rule will be created under. |
The data required for the new rule.
rule_data required | object Required. The rule logic data. |
component | any or null Default: null |
required | object (EmailActionArgsSchema) |
action required | string Required. The type of the action. |
rule_schema required | string <= 255 characters |
{- "rule_data": { },
- "component": null,
- "action_args": {
- "template": "NotifyTemplate",
- "recipients": [
- "user@example.com"
]
}, - "action": "SEND_EMAIL",
- "rule_schema": "string"
}
{- "rule_data": { },
- "component": null,
- "created_on": "2019-08-24T14:15:22Z",
- "action_args": { },
- "action": "SEND_EMAIL",
- "rule_schema": "string",
- "updated_on": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
Updates attributes for a single rule. Use this request to change a rule name and description or set its status to active or inactive.
rule_id required | string |
The update data for the rule.
rule_data | object Required. The rule logic data. |
component | string or null <uuid> Optional. If an ID is specified, the rule will only apply to the specified component. |
object (EmailActionArgsSchema) | |
action | string The name of the action. |
{- "rule_data": { },
- "component": "593c6441-422a-4835-83e3-e0651f631fef",
- "action_args": {
- "template": "NotifyTemplate",
- "recipients": [
- "user@example.com"
]
}, - "action": "SEND_EMAIL"
}
{- "rule_data": { },
- "component": null,
- "created_on": "2019-08-24T14:15:22Z",
- "action_args": { },
- "action": "SEND_EMAIL",
- "rule_schema": "string",
- "updated_on": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
Retrieves the details of a single rule by its ID.
rule_id required | string |
{- "rule_data": { },
- "component": null,
- "created_on": "2019-08-24T14:15:22Z",
- "action_args": {
- "template": "NotifyTemplate",
- "recipients": [
- "user@example.com"
]
}, - "action": "SEND_EMAIL",
- "rule_schema": "string",
- "updated_on": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "journey": "9145b29e-e005-46f9-b016-19d8056c2825"
}
List all runs in a pipeline.
project_id required | string <uuid> the ID of the project being queried. |
status | Array of strings Optional. If specified, the results will be limited to run with one of the specified statuses. |
pipeline_id | boolean Optional. Specifies which pipelines to include by their ID. All pipelines are selected if unset. |
start_range_begin | string <date> Optional. An ISO8601 datetime. If specified, The result will only include runs with a start_time field equal or past the given datetime. May be specified with start_range_end to create a range. |
start_range_end | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain runs with a start_time field before the given datetime. May be specified with start_range_begin to create a range. |
end_range_begin | string <date> Optional. An ISO8601 datetime. If specified, The result will only include runs with an end_time field equal or past the given datetime. May be specified with end_range_end to create a range. |
end_range_end | string <date> Optional. An ISO8601 datetime. If specified, The result will only include runs with an end_time field before the given datetime. May be specified with end_range_begin to create a range. |
pipeline_key | Array of strings Optional. If specified, the results will be limited to runs with the pipeline keys. |
run_key | Array of strings Optional. If specified, the results will be limited to runs with one of the listed keys. |
instance_id | Array of strings Optional. If specified, the results will be limited to runs with one of the listed instance ids. |
tool | Array of strings Optional. If specified, the results will be limited to runs using the listed tools. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the run list. The sort is applied to the list before pagination. |
search | string Optional. A case-insensitive search query. If specified, runs with keys or names that have a partial or full match to the query will be listed. |
{- "entities": [
- {
- "status": "string",
- "end_time": "2019-08-24T14:15:22Z",
- "tasks_summary": [
- {
- "count": 0,
- "status": "string"
}
], - "expected_end_time": "2019-08-24T14:15:22Z",
- "alerts": [
- {
- "details": { },
- "run": null,
- "type": "LATE_END",
- "created_on": "2019-08-24T14:15:22Z",
- "description": "string",
- "level": "WARNING",
- "updated_on": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "pipeline": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "tool": null,
- "display_name": "string"
}, - "tests_summary": [
- {
- "count": 0,
- "status": "PASSED"
}
], - "start_time": "2019-08-24T14:15:22Z",
- "updated_on": "string",
- "expected_start_time": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "instance_set": null,
- "name": "string"
}
], - "total": 0
}
Retrieves the details of a single run by its ID.
run_id required | string |
{- "status": "string",
- "end_time": "2019-08-24T14:15:22Z",
- "tasks_summary": [
- {
- "count": 0,
- "status": "string"
}
], - "expected_end_time": "2019-08-24T14:15:22Z",
- "alerts": [
- {
- "details": { },
- "run": null,
- "type": "LATE_END",
- "created_on": "2019-08-24T14:15:22Z",
- "description": "string",
- "level": "WARNING",
- "updated_on": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "pipeline": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "tool": null,
- "display_name": "string"
}, - "tests_summary": [
- {
- "count": 0,
- "status": "PASSED"
}
], - "start_time": "2019-08-24T14:15:22Z",
- "updated_on": "string",
- "expected_start_time": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "instance_set": null,
- "name": "string"
}
Lists all schedules for the given component.
The route observability/batch-pipelines/<pipeline-id>/schedules is deprecated and will be removed in a future release.
component_id required | string the ID of the component being queried. |
{- "entities": [
- {
- "margin": 0,
- "timezone": "America/Sao_Paulo",
- "component": "593c6441-422a-4835-83e3-e0651f631fef",
- "created_on": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": "15 * * * 1,3,5",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "expectation": "BATCH_PIPELINE_START_TIME",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "total": 0
}
Creates a new schedule that sets the given component time-based expectations.
The route observability/batch-pipelines/<pipeline-id>/schedules is deprecated and will be removed in a future release.
component_id required | string The ID of the component that the schedule will be created under. |
The data required for the new schedule.
margin | integer or null The expectation's margin-of-error in seconds, it must be expressed in increments of 60. Required when 'expectation' is one of 'BATCH_PIPELINE_START_TIME', 'DATASET_ARRIVAL'; disallowed otherwise. |
timezone | string Default: "UTC" Optional. The local timezone of the expression defined by the schedule parameter, as an IANA long or short database name. If unspecified, the schedule defaults to 'UTC'. |
description | string An optional description of the schedule. |
schedule required | string Required. A cron expression that defines when the 'expectation' should occur. Does not support cron extensions. Recommended minimum no less than 10 minutes. |
expectation | string Enum: "BATCH_PIPELINE_START_TIME" "BATCH_PIPELINE_END_TIME" "DATASET_ARRIVAL" Required. Defines what is expected to happen at the given schedule. |
{- "margin": 0,
- "timezone": "America/Sao_Paulo",
- "description": "string",
- "schedule": "15 * * * 1,3,5",
- "expectation": "BATCH_PIPELINE_START_TIME"
}
{- "margin": 0,
- "timezone": "America/Sao_Paulo",
- "component": "593c6441-422a-4835-83e3-e0651f631fef",
- "created_on": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": "15 * * * 1,3,5",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "expectation": "BATCH_PIPELINE_START_TIME",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Lists service account keys in the project.
project_id required | string The ID of the project that the service account key will be created under. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the key list. The sort is applied to the list before pagination. |
search | string Filters the returned list by searching the key name and description. |
{- "entities": [
- {
- "description": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allowed_services": [
- "EVENTS_API"
], - "name": "string"
}
], - "total": 0
}
Creates a new service account key for a specified project.
project_id required | string The ID of the project that the service account key will be created under. |
The data required for the new service account key.
expires_after_days required | integer |
description | string or null <= 255 characters |
allowed_services required | Array of strings non-empty Items Enum: "EVENTS_API" "OBSERVABILITY_API" "AGENT_API" Required. Services for which the key will be valid. |
name required | string [ 1 .. 255 ] characters |
{- "expires_after_days": 0,
- "description": "string",
- "allowed_services": [
- "EVENTS_API"
], - "name": "string"
}
{- "description": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allowed_services": [
- "EVENTS_API"
], - "token": "string",
- "name": "string"
}
List all RunTasks in a Run.
run_id required | string <uuid> the ID of the run being queried. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the task run list. Sorting is done on start_time. |
{- "entities": [
- {
- "status": "PENDING",
- "run": null,
- "start_time": "2019-08-24T14:15:22Z",
- "task": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "display_name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "required": false,
- "end_time": "2019-08-24T14:15:22Z"
}
], - "total": 0
}
Lists all users in the system, filtered by optional parameters.
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the user list. The sort is applied to the list before pagination. |
primary_company | string Optional. A company ID for filtering the user list. |
name | string Optional. A substring for filtering the user list to partial user name matches. |
{- "entities": [
- {
- "primary_company": "9d7017c9-01cc-4719-9168-968a37f72afa",
- "username": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "email": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
], - "total": 0
}
Creates a new user in the system using the specified primary company ID.
The minimally required data for the new user.
username | string |
email required | string |
name required | string |
{- "username": "string",
- "email": "string",
- "name": "string"
}
{- "primary_company": "9d7017c9-01cc-4719-9168-968a37f72afa",
- "username": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "email": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Use this request to change a user name, grant administrator access, or set its status to active or inactive.
user_id required | string |
The updated data for the user.
active | any |
admin | any |
name required | string |
{- "active": null,
- "admin": null,
- "name": "string"
}
{- "primary_company": "9d7017c9-01cc-4719-9168-968a37f72afa",
- "username": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "email": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Retrieves a single user by its ID.
user_id required | string |
{- "primary_company": "9d7017c9-01cc-4719-9168-968a37f72afa",
- "username": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "email": "string",
- "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
Lists all components for the project using the specified project ID.
project_id required | string the ID of the project being queried. |
component_type | Array of strings Optional. If specified, the results will be limited to components with the listed types. |
tool | Array of strings Optional. If specified, the results will be limited to components with the listed tools. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the component list. The sort is applied to the list before pagination. |
search | string Optional. A case-insensitive search query. If specified, only component keys with a partial or full match to the query will be listed. |
{- "entities": [
- {
- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
], - "total": 0
}
Permanently deletes a single component by its ID including all the associated runs and stored events.
component_id required | string |
{- "error": "An error message.",
- "details": {
- "key": "value"
}
}
Retrieves a single component by its ID.
component_id required | string |
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Lists all components for the journey using the specified journey ID.
journey_id required | string the ID of the journey being queried. |
component_type | Array of strings Optional. If specified, the results will be limited to components with the listed types. |
tool | Array of strings Optional. If specified, the results will be limited to components with the listed tools. |
page | integer Default: 1 A page number to use for pagination. All pagination starts with 1. |
count | integer Default: 10 The number of results to display per page. |
sort | string Default: "ASC" Enum: "ASC" "DESC" The sort order for the component list. The sort is applied to the list before pagination. |
search | string Optional. A case-insensitive search query. If specified, only component keys with a partial or full match to the query will be listed. |
{- "entities": [
- {
- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
], - "total": 0
}
List upcoming instances of a project.
project_id required | string the ID of the project being queried. |
journey_id | Array of strings <uuid> Optional. Specifies which journeys to include by their ID. All journeys are selected if unset. |
journey_name | Array of strings Optional. If specified, the results will be limited to instances with the journeys named. |
start_range required | string <date> An ISO8601 datetime. If specified, The result will only include upcoming instances with a expected start or end time equal or past the given datetime. |
end_range | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain instances with a expected start or end time before the given datetime. |
count | integer Default: 10 The number of results to display. |
{- "entities": [
- {
- "expected_end_time": "2019-08-24T14:15:22Z",
- "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}, - "expected_start_time": "2019-08-24T14:15:22Z",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}
]
}
List upcoming instances of a company.
project_id | Array of strings <uuid> Optional. Specifies the project IDs to include. All projects are selected if unset. |
journey_id | Array of strings <uuid> Optional. Specifies which journeys to include by their ID. All journeys are selected if unset. |
journey_name | Array of strings Optional. If specified, the results will be limited to instances with the journeys named. |
start_range required | string <date> An ISO8601 datetime. If specified, The result will only include upcoming instances with a expected start or end time equal or past the given datetime. |
end_range | string <date> Optional. An ISO8601 datetime. If specified, the result will only contain instances with a expected start or end time before the given datetime. |
count | integer Default: 10 The number of results to display. |
{- "entities": [
- {
- "expected_end_time": "2019-08-24T14:15:22Z",
- "journey": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": null
}, - "expected_start_time": "2019-08-24T14:15:22Z",
- "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}
}
]
}
Creates a new batch-pipeline component in the specified project.
project_id required | string The ID of the project that the batch-pipeline will be created under. |
The data required for the new batch-pipeline component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ Default: null |
type | string Default: "BATCH_PIPELINE" Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER" |
description | string or null <= 255 characters Default: null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string |
{- "tool": null,
- "type": "BATCH_PIPELINE",
- "description": null,
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Updates attributes of a single batch-pipeline component.
component_id required | string |
The update data for the batch-pipeline component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ |
description | string or null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string or null |
{- "tool": "string",
- "description": "string",
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Retrieves a single batch-pipeline component by ID.
component_id required | string |
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Creates a new dataset component in the specified project.
project_id required | string The ID of the project that the dataset will be created under. |
The data required for the new dataset component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ Default: null |
type | string Default: "DATASET" Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER" |
description | string or null <= 255 characters Default: null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string |
{- "tool": null,
- "type": "BATCH_PIPELINE",
- "description": null,
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Updates attributes of a single dataset component.
component_id required | string |
The update data for the dataset component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ |
description | string or null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string or null |
{- "tool": "string",
- "description": "string",
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Retrieves a single dataset component by ID.
component_id required | string |
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Creates a new server component in the specified project.
project_id required | string The ID of the project that the server will be created under. |
The data required for the new server component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ Default: null |
type | string Default: "SERVER" Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER" |
description | string or null <= 255 characters Default: null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string |
{- "tool": null,
- "type": "BATCH_PIPELINE",
- "description": null,
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Updates attributes of a single server component.
component_id required | string |
The update data for the server component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ |
description | string or null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string or null |
{- "tool": "string",
- "description": "string",
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Retrieves a single server component by ID.
component_id required | string |
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Creates a new streaming-pipeline component in the specified project.
project_id required | string The ID of the project that the streaming-pipeline will be created under. |
The data required for the new streaming-pipeline component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ Default: null |
type | string Default: "STREAMING_PIPELINE" Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER" |
description | string or null <= 255 characters Default: null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string |
{- "tool": null,
- "type": "BATCH_PIPELINE",
- "description": null,
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Updates attributes of a single streaming-pipeline component.
component_id required | string |
The update data for the streaming-pipeline component.
tool | string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$ |
description | string or null |
key | string [ 1 .. 255 ] characters |
labels | object |
name | string or null |
{- "tool": "string",
- "description": "string",
- "key": "string",
- "labels": { },
- "name": "string"
}
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}
Retrieves a single streaming-pipeline component by ID.
component_id required | string |
{- "tool": null,
- "display_name": "string",
- "type": "BATCH_PIPELINE",
- "created_on": "2019-08-24T14:15:22Z",
- "description": null,
- "integrations": [
- {
- "database_name": "string",
- "uses_sampling": false,
- "sample_percentage": null,
- "project_code": null,
- "connection_name": "string",
- "table_exclude_pattern": null,
- "table_group_id": null,
- "schema": null,
- "component": null,
- "table_list": [
- "string"
], - "sample_minimum_count": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "integration_name": "string",
- "table_include_pattern": null
}
], - "created_by": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}, - "updated_on": "string",
- "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": "string",
- "labels": { },
- "name": "string"
}