SVsvix
Sink

List Sinks

Changed on

List of all the stream's sinks.

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

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/stream/{stream_id}/sink
  • Auth
    HTTP bearer

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

Query parameters

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:sink_2yZwUhtgs5Ai8T9yRQJXA
order'ascending' | 'descending'

Defines the ordering in a listing of results.

The sorting order of the returned items

Response

doneboolean required
iteratorstring nullable required
prevIteratorstring nullable

Example response

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

Changes

  • 77555fa3a659Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • info

      added postHog discriminator mapping keys to the / response property for the response status

  • cca56e67e5a4Revision changes
    • info

      added the required property to the response with the status