Integrations

Get details on existing data stream

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `DataStream` + `Get` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> 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
namestringOptional
Descriptive name or purpose of the data stream
destinationobjectOptional
filterslist of objectsOptional
data_stream_typeanyOptional
relation_resolutionanyOptional
statusobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error