v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Sink

List Sinks

List of all the stream's sinks.

get/api/v1/stream/{stream_id}/sink

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

Query parameters

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:sink_2yZwUhtgs5Ai8T9yRQJXA

The iterator returned from a prior invocation

order'ascending' | 'descending'

Defines the ordering in a listing of results.

The sorting order of the returned items

Response

iteratorstring nullable required

prevIteratorstring nullable

doneboolean required

Example response

{
  "data": [
    {
      "id": "sink_2yZwUhtgs5Ai8T9yRQJXA",
      "uid": "unique-identifier",
      "eventTypes": [
        "user.signup"
      ]
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}