API docs by Redocly

DataOps Observability Platform API (1.0.0)

Download OpenAPI specification:Download

DataKitchen Support: support@datakitchen.io URL: https://datakitchen.io License: Proprietary, All rights reserved.

The DataOps Observability Platform API.

WARNING: This is an internal API and is subject to unannounced breaking changes.

Agent

ListAgents

Lists all agents for the project using the specified project ID.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

the ID of the project being queried.

query 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 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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

Auth

PostSSOLogin

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.

Authorizations:
APIKeySAKeyBasic
Request Body schema: application/json

Data required to generate a new valid JWT.

state
string
Default: ""
redirect_url
string <url>
code
required
string

Responses

Request samples

Content type
application/json
{
  • "state": "",
  • "redirect_url": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

GetSSOLogin

Retrieves the URL for SSO authentication so the app can redirect users. Warning - This endpoint is not intended for use by end users.

Authorizations:
APIKeySAKeyBasic
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "login_url": "string"
}

GetSSOLogout

Revokes the access token provided by the SSO Authority. This endpoint is not intended for use by end users.

Authorizations:
APIKeySAKeyBasic

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

GetAuthLogin

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.

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

Company

PostCompany

Creates a new company using the specified name.

Authorizations:
APIKey
Request Body schema: application/json

The data required to create the new Company and Authentication Provider.

name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_by": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

ListCompanies

Lists all companies in the system.

Authorizations:
APIKey
query 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 company list. The sort is applied to the list before pagination.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteCompanyById

Permanently deletes a single company by its ID.

Authorizations:
APIKey
path Parameters
company_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PatchCompanyById

Updates attributes for a single company. Use this request to change a company name or set its status to active or inactive.

Authorizations:
APIKey
path Parameters
company_id
required
string
Request Body schema: application/json

The new data for the company.

name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_by": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

GetCompanyById

Retrieves a single company by its ID.

Authorizations:
APIKey
path Parameters
company_id
required
string

Responses

Response samples

Content type
application/json
{
  • "created_by": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Instance

ListInstances

List all instances of a journey.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

the ID of the project being queried.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

GetInstanceById

Retrieves a single instance by its ID.

Authorizations:
APIKeySAKey
path Parameters
instance_id
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "payload_key": "string",
  • "project": {
    },
  • "start_type": "BATCH",
  • "status": "ERROR",
  • "end_time": "2019-08-24T14:15:22Z",
  • "journey": {
    },
  • "runs_summary": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "alerts_summary": [
    ],
  • "tests_summary": [
    ],
  • "start_time": "2019-08-24T14:15:22Z",
  • "expected_end_time": "2019-08-24T14:15:22Z"
}

ListCompanyInstances

List all instances in the company.

Authorizations:
APIKeySAKey
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

Search

ListInstancesSearch

List all instances of a journey.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

the ID of the project being queried.

Request Body schema: application/json

Search parameters payload

object

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

InstanceRule

DeleteInstanceRule

Permanently deletes a single instance rule by its ID.

Authorizations:
APIKeySAKey
path Parameters
instance_rule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PostInstanceRule

Creates a new instance rule in a journey.

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string

The ID of the journey that the instance rule will be created under.

Request Body schema: application/json

The data required for the new instance rule.

object (ScheduleInstanceRule)
action
required
string
Enum: "START" "END" "END_PAYLOAD"

Required. The selected action to perform when the rule's condition is satisfied.

batch_pipeline
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "schedule": {
    },
  • "action": "START",
  • "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed"
}

Response samples

Content type
application/json
{
  • "journey": "9145b29e-e005-46f9-b016-19d8056c2825",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "schedule": {
    },
  • "action": "START",
  • "batch_pipeline": "fe3da2d2-746e-4f11-8660-0a585538beed"
}

Journey

PostJourney

Creates a new journey in a project using the specified name and project ID.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

The ID of the project that the journey will be created under.

Request Body schema: application/json

The data required for the new journey.

description
string or null <= 255 characters
Default: null
name
string or null <= 255 characters
Default: null

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "name": null
}

Response samples

Content type
application/json
{
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "name": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updated_on": "string",
  • "instance_rules": [
    ],
  • "created_by": {
    }
}

ListJourneys

Lists all journeys for the project using the specified project ID.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

the ID of the project being queried.

query 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 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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteJourneyById

Permanently deletes a single journey by its ID.

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PatchJourneyById

Updates attributes for a single journey. Use this request to change a journey name and description

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string
Request Body schema: application/json

The update data for the journey.

description
string or null
name
string or null

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "name": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updated_on": "string",
  • "instance_rules": [
    ],
  • "created_by": {
    }
}

GetJourneyById

Retrieves a single journey by its ID.

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "name": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updated_on": "string",
  • "instance_rules": [
    ],
  • "created_by": {
    }
}

JourneyDag

Retrieves the DAG by the ID of it's journey.

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

JourneyDag

CreateJourneyDagEdge

Creates a new DAG edge for a Journey.

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string

The ID of the Journey that the DAG edge will be created under.

Request Body schema: application/json

The data required for the new DAG edge.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "right": "a4e90aa1-5aef-4eb1-8681-fc980d6cdf85",
  • "left": "022cd5fc-3f5c-4d6d-89e8-e877d6d1ad13"
}

DeleteDagEdgeById

Permanently deletes a single user by its ID.

Authorizations:
APIKeySAKey
path Parameters
edge_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

Organization

PostOrganization

Creates a new organization in a company using the specified name and company ID.

Authorizations:
APIKey
path Parameters
company_id
required
string

the ID of the requested company.

Request Body schema: application/json

The data required for the new organization.

description
string or null <= 255 characters
Default: null
name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "company": "87340f10-f684-4b06-8427-5981380bd9a9",
  • "created_by": {
    }
}

ListOrganizations

Lists all organizations in a company using the specified company ID.

Authorizations:
APIKey
path Parameters
company_id
required
string

the ID of the requested company.

query 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 organization list. The sort is applied to the list before pagination.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteOrganizationById

Permanently deletes a single organization by its ID.

Authorizations:
APIKey
path Parameters
organization_id
required
string

ID of organization to be deleted.

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PatchOrganizationById

Updates attributes for a single organization. Use this request to change an organization name and description.

Authorizations:
APIKey
path Parameters
organization_id
required
string
Request Body schema: application/json

The new data for the organization.

description
string or null <= 255 characters
Default: null
name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "company": "87340f10-f684-4b06-8427-5981380bd9a9",
  • "created_by": {
    }
}

GetOrganizationById

Retrieves a single organization by its ID.

Authorizations:
APIKey
path Parameters
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "company": "87340f10-f684-4b06-8427-5981380bd9a9",
  • "created_by": {
    }
}

Project

PostProject

Creates a new project in an organization using the specified name and organization ID.

Authorizations:
APIKey
path Parameters
organization_id
required
string

The ID of organization that the project will be created under.

Request Body schema: application/json

The data required for the new project.

active
boolean
Default: true
description
string or null <= 255 characters
Default: null
name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "description": null,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  • "created_by": {
    }
}

ListProjects

Lists all projects in an organization using the specified organization ID.

Authorizations:
APIKeySAKeyBasic
path Parameters
organization_id
required
string

The ID of organization being queried for projects.

query 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 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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteProjectById

Permanently deletes a single project by its ID.

Authorizations:
APIKey
path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PatchProjectById

Updates attributes for a single project. Use this request to change a project name and description or set its status to active or inactive.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string
Request Body schema: application/json

The update data for the project.

description
string or null <= 255 characters
Default: null
name
required
string <= 255 characters
active
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "name": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  • "created_by": {
    }
}

GetProjectById

Retrieves a single project by its ID.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "description": null,
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  • "created_by": {
    }
}

ProjectEvents

Retrieves events by project_id.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

ProjectAlerts

Retrieves alerts by project_id.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "instance": "868cf2e9-bd6d-4bac-96ba-2b08120d8cf9",
  • "run": {
    },
  • "level": "WARNING",
  • "type": "LATE_END",
  • "details": { },
  • "components": [
    ]
}

Events

ProjectEvents

Retrieves events by project_id.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

TestOutcome

ListProjectTestOutcomes

List all test outcomes in a project.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

the ID of the project being queried.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

GetTestOutcomeById

Retrieves a single test outcome by its ID.

Authorizations:
APIKeySAKey
path Parameters
test_outcome_id
required
string

Responses

Response samples

Content type
application/json
{
  • "instance_set": null,
  • "min_threshold": 3.14,
  • "task": null,
  • "status": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "metric_description": null,
  • "integrations": [
    ],
  • "component": {
    },
  • "dimensions": [
    ],
  • "end_time": "2019-08-24T14:15:22Z",
  • "external_url": null,
  • "run": null,
  • "updated_on": "string",
  • "result": null,
  • "metric_value": 10.22,
  • "description": null,
  • "key": null,
  • "max_threshold": 6.28,
  • "type": null,
  • "start_time": "2019-08-24T14:15:22Z",
  • "metric_name": null
}

Alerts

ProjectAlerts

Retrieves alerts by project_id.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "instance": "868cf2e9-bd6d-4bac-96ba-2b08120d8cf9",
  • "run": {
    },
  • "level": "WARNING",
  • "type": "LATE_END",
  • "details": { },
  • "components": [
    ]
}

Role

PostRole

Creates a new using the specified name and description.

Authorizations:
APIKey
Request Body schema: application/json

The data for the new Role

description
string or null <= 255 characters
Default: null
name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

ListRoles

List all available roles.

Authorizations:
APIKey
query 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 role list. The sort is applied to the list before pagination.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteRoleById

Permanently deletes a single role by its ID.

Authorizations:
APIKey
path Parameters
role_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PatchRoleById

Updates attributes for a single role. Use this request to change a role name or description.

Authorizations:
APIKey
path Parameters
role_id
required
string
Request Body schema: application/json

The update data for the role.

description
string or null <= 255 characters
Default: null
name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

GetRoleById

Retrieve a single role by its ID.

Authorizations:
APIKey
path Parameters
role_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Rule

PostRule

Creates a new rule associated with a Journey.

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string

The ID of journey that the rule will be created under.

Request Body schema: application/json

The data required for the new rule.

required
object (EmailActionArgsSchema)
component
any or null
Default: null
rule_schema
required
string <= 255 characters
rule_data
required
object

Required. The rule logic data.

action
required
string

Required. The type of the action.

Responses

Request samples

Content type
application/json
Example
{
  • "action_args": {
    },
  • "component": null,
  • "rule_schema": "string",
  • "rule_data": { },
  • "action": "SEND_EMAIL"
}

Response samples

Content type
application/json
{
  • "created_on": "2019-08-24T14:15:22Z",
  • "action_args": { },
  • "component": null,
  • "journey": "9145b29e-e005-46f9-b016-19d8056c2825",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rule_schema": "string",
  • "updated_on": "string",
  • "rule_data": { },
  • "action": "SEND_EMAIL"
}

ListRules

List all rules that attached to a journey.

Authorizations:
APIKeySAKey
path Parameters
journey_id
required
string

the ID of the journey being queried.

query 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 rules list. The sort is applied to the list before pagination.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteRuleById

Permanently deletes a single rule by its ID.

Authorizations:
APIKey
path Parameters
rule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PatchRuleById

Updates attributes for a single rule. Use this request to change a rule name and description or set its status to active or inactive.

Authorizations:
APIKey
path Parameters
rule_id
required
string
Request Body schema: application/json

The update data for the rule.

object (EmailActionArgsSchema)
component
string or null <uuid>

Optional. If an ID is specified, the rule will only apply to the specified component.

action
string

The name of the action.

rule_data
object

Required. The rule logic data.

Responses

Request samples

Content type
application/json
Example
{
  • "action_args": {
    },
  • "component": "593c6441-422a-4835-83e3-e0651f631fef",
  • "action": "SEND_EMAIL",
  • "rule_data": { }
}

Response samples

Content type
application/json
{
  • "created_on": "2019-08-24T14:15:22Z",
  • "action_args": { },
  • "component": null,
  • "journey": "9145b29e-e005-46f9-b016-19d8056c2825",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rule_schema": "string",
  • "updated_on": "string",
  • "rule_data": { },
  • "action": "SEND_EMAIL"
}

GetRuleById

Retrieves the details of a single rule by its ID.

Authorizations:
APIKeySAKey
path Parameters
rule_id
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "created_on": "2019-08-24T14:15:22Z",
  • "action_args": {
    },
  • "component": null,
  • "journey": "9145b29e-e005-46f9-b016-19d8056c2825",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rule_schema": "string",
  • "updated_on": "string",
  • "rule_data": { },
  • "action": "SEND_EMAIL"
}

Run

ListRuns

List all runs in a pipeline.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string <uuid>

the ID of the project being queried.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

GetRunById

Retrieves the details of a single run by its ID.

Authorizations:
APIKeySAKey
path Parameters
run_id
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "instance_set": null,
  • "expected_start_time": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "end_time": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "pipeline": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updated_on": "string",
  • "alerts": [
    ],
  • "tasks_summary": [
    ],
  • "tests_summary": [
    ],
  • "start_time": "2019-08-24T14:15:22Z",
  • "expected_end_time": "2019-08-24T14:15:22Z"
}

Schedule

PostSchedule

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.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string

The ID of the component that the schedule will be created under.

Request Body schema: application/json

The data required for the new schedule.

description
string

An optional description of the schedule.

expectation
string
Enum: "BATCH_PIPELINE_START_TIME" "BATCH_PIPELINE_END_TIME" "DATASET_ARRIVAL"

Required. Defines what is expected to happen at the given 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.

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'.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "expectation": "BATCH_PIPELINE_START_TIME",
  • "schedule": "15 * * * 1,3,5",
  • "margin": 0,
  • "timezone": "America/Sao_Paulo"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "component": "593c6441-422a-4835-83e3-e0651f631fef",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "expectation": "BATCH_PIPELINE_START_TIME",
  • "updated_on": "string",
  • "schedule": "15 * * * 1,3,5",
  • "margin": 0,
  • "timezone": "America/Sao_Paulo",
  • "created_by": {
    }
}

ListSchedules

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.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string

the ID of the component being queried.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteScheduleById

Permanently deletes a single schedule by its ID.

Authorizations:
APIKeySAKey
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

ServiceAccountKey

PostServiceAccountKey

Creates a new service account key for a specified project.

Authorizations:
APIKey
path Parameters
project_id
required
string

The ID of the project that the service account key will be created under.

Request Body schema: application/json

The data required for the new service account key.

description
string or null <= 255 characters
name
required
string [ 1 .. 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.

expires_after_days
required
integer

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "allowed_services": [
    ],
  • "expires_after_days": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "token": "string",
  • "allowed_services": [
    ],
  • "expires_at": "2019-08-24T14:15:22Z"
}

ListServiceAccountKeys

Lists service account keys in the project.

Authorizations:
APIKey
path Parameters
project_id
required
string

The ID of the project that the service account key will be created under.

query 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 key list. The sort is applied to the list before pagination.

search
string

Filters the returned list by searching the key name and description.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteServiceAccountKeyById

Permanently deletes a service account key.

Authorizations:
APIKey
path Parameters
key_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

Task

ListRunTasks

List all RunTasks in a Run.

Authorizations:
APIKeySAKey
path Parameters
run_id
required
string <uuid>

the ID of the run being queried.

query Parameters
sort
string
Default: "ASC"
Enum: "ASC" "DESC"

The sort order for the task run list. Sorting is done on start_time.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

User

PostUser

Creates a new user in the system using the specified primary company ID.

Authorizations:
APIKey
Request Body schema: application/json

The minimally required data for the new user.

name
required
string
username
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "username": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "primary_company": "9d7017c9-01cc-4719-9168-968a37f72afa",
  • "created_by": {
    },
  • "username": "string",
  • "email": "string"
}

ListUsers

Lists all users in the system, filtered by optional parameters.

Authorizations:
APIKey
query 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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteUserById

Permanently deletes a single user by its ID.

Authorizations:
APIKey
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

PatchUserById

Use this request to change a user name, grant administrator access, or set its status to active or inactive.

Authorizations:
APIKey
path Parameters
user_id
required
string
Request Body schema: application/json

The updated data for the user.

admin
any
name
required
string
active
any

Responses

Request samples

Content type
application/json
{
  • "admin": null,
  • "name": "string",
  • "active": null
}

Response samples

Content type
application/json
{
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "primary_company": "9d7017c9-01cc-4719-9168-968a37f72afa",
  • "created_by": {
    },
  • "username": "string",
  • "email": "string"
}

GetUserById

Retrieves a single user by its ID.

Authorizations:
APIKey
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "created_on": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "primary_company": "9d7017c9-01cc-4719-9168-968a37f72afa",
  • "created_by": {
    },
  • "username": "string",
  • "email": "string"
}

Component

ListComponents

Lists all components for the project using the specified project ID.

Authorizations:
APIKey
path Parameters
project_id
required
string

the ID of the project being queried.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

DeleteComponentById

Permanently deletes a single component by its ID including all the associated runs and stored events.

Authorizations:
APIKey
path Parameters
component_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "An error message.",
  • "details": {
    }
}

GetComponentById

Retrieves a single component by its ID.

Authorizations:
APIKey
path Parameters
component_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

ListComponentsByJourney

Lists all components for the journey using the specified journey ID.

Authorizations:
APIKey
path Parameters
journey_id
required
string

the ID of the journey being queried.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "total": 0
}

UpcomingInstance

ListUpcomingInstances

List upcoming instances of a project.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

the ID of the project being queried.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

ListCompanyUpcomingInstances

List upcoming instances of a company.

Authorizations:
APIKey
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Batch-Pipeline

PostBatchPipelineComponents

Creates a new batch-pipeline component in the specified project.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

The ID of the project that the batch-pipeline will be created under.

Request Body schema: application/json

The data required for the new batch-pipeline component.

description
string or null <= 255 characters
Default: null
key
string [ 1 .. 255 ] characters
labels
object
name
string
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$
Default: null
type
string
Default: "BATCH_PIPELINE"
Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER"

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": null,
  • "type": "BATCH_PIPELINE"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

PatchBatchPipelineComponentById

Updates attributes of a single batch-pipeline component.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string
Request Body schema: application/json

The update data for the batch-pipeline component.

description
string or null
key
string [ 1 .. 255 ] characters
labels
object
name
string or null
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

GetBatchPipelineComponentById

Retrieves a single batch-pipeline component by ID.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

Dataset

PostDatasetComponents

Creates a new dataset component in the specified project.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

The ID of the project that the dataset will be created under.

Request Body schema: application/json

The data required for the new dataset component.

description
string or null <= 255 characters
Default: null
key
string [ 1 .. 255 ] characters
labels
object
name
string
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$
Default: null
type
string
Default: "DATASET"
Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER"

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": null,
  • "type": "BATCH_PIPELINE"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

PatchDatasetComponentById

Updates attributes of a single dataset component.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string
Request Body schema: application/json

The update data for the dataset component.

description
string or null
key
string [ 1 .. 255 ] characters
labels
object
name
string or null
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

GetDatasetComponentById

Retrieves a single dataset component by ID.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

Server

PostServerComponents

Creates a new server component in the specified project.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

The ID of the project that the server will be created under.

Request Body schema: application/json

The data required for the new server component.

description
string or null <= 255 characters
Default: null
key
string [ 1 .. 255 ] characters
labels
object
name
string
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$
Default: null
type
string
Default: "SERVER"
Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER"

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": null,
  • "type": "BATCH_PIPELINE"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

PatchServerComponentById

Updates attributes of a single server component.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string
Request Body schema: application/json

The update data for the server component.

description
string or null
key
string [ 1 .. 255 ] characters
labels
object
name
string or null
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

GetServerComponentById

Retrieves a single server component by ID.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

Streaming-Pipeline

PostStreamingPipelineComponents

Creates a new streaming-pipeline component in the specified project.

Authorizations:
APIKeySAKey
path Parameters
project_id
required
string

The ID of the project that the streaming-pipeline will be created under.

Request Body schema: application/json

The data required for the new streaming-pipeline component.

description
string or null <= 255 characters
Default: null
key
string [ 1 .. 255 ] characters
labels
object
name
string
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$
Default: null
type
string
Default: "STREAMING_PIPELINE"
Enum: "BATCH_PIPELINE" "STREAMING_PIPELINE" "DATASET" "SERVER"

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": null,
  • "type": "BATCH_PIPELINE"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

PatchStreamingPipelineComponentById

Updates attributes of a single streaming-pipeline component.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string
Request Body schema: application/json

The update data for the streaming-pipeline component.

description
string or null
key
string [ 1 .. 255 ] characters
labels
object
name
string or null
tool
string or null [ 1 .. 255 ] characters ^(?!_)[\w ]*(?<!_)$

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "key": "string",
  • "labels": { },
  • "name": "string",
  • "tool": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}

GetStreamingPipelineComponentById

Retrieves a single streaming-pipeline component by ID.

Authorizations:
APIKeySAKey
path Parameters
component_id
required
string

Responses

Response samples

Content type
application/json
{
  • "description": null,
  • "key": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "labels": { },
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "display_name": "string",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tool": null,
  • "updated_on": "string",
  • "type": "BATCH_PIPELINE",
  • "created_by": {
    },
  • "integrations": [
    ]
}