Skip to navigation
IntegrationsGet details on existing data stream

Get details on existing data stream

Required permissions Beta Learn more

DataStream + Get

Roles: Administrator User Observer

Get data stream configuration and status by ID.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

data_stream_idstringRequired
ID of a data stream.

Response

Single Data Stream Configuration
idstringOptional
ID of the data stream
namestringOptional
Descriptive name or purpose of the data stream
destinationobjectOptional
filterslist of objectsOptional
Conditions to filter the streamed data.
data_stream_typeanyOptional
relation_resolutionanyOptional
statusobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error