Stream Management

The stream management endpoints bring independence and flexibility to our customers. They let customers integrate stream management into their workflow.

Stream creation

Create a stream if you have access to only one organization:

curl --location --request POST 'https://stream-api.productsup.com/streams' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--data-raw '{
  "data": {
    "type": "stream",
    "attributes": {
      "name": "My product stream",
      "type": "chunked"
    }
  }
}'

Create a stream if you have access to multiple organizations:

curl --location --request POST 'https://stream-api.productsup.com/streams' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--data-raw '{
  "data": {
    "type": "stream",
    "attributes": {
      "name": "My product stream",
      "type": "chunked"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": ID_OF_ORGANIZATION_WHERE_STREAM_SHOULD_BE_CREATED
      }
    }
  }
}'

When you create a stream, you have two required attributes and one optional:

name (required) is the arbitrary value you can use to identify your stream. This attribute is also visible in the UI when you select a stream in Data Sources.

type (required) is a stream type, such as chunked or referenced. See Stream types: chunked and referenced.

relationships (optional) is an attribute that lets you determine which organization you want to create a stream for. Apply this attribute only if you have access to multiple organizations. By default, the platform will create a stream in your first or only existing organization. Please note that we still use the term "account" in the relationships-attribute instead of the term "organization", they do refer to the same entity.

List Stream

List all Streams:

curl --location --request GET 'https://stream-api.productsup.com/streams' \
--header 'Accept: application/vnd.api+json'

List Streams next page:

curl --location --request GET 'https://stream-api.productsup.com/streams?page[offset]=10&page[limit]=10' \
--header 'Accept: application/vnd.api+json'

List a specific Stream:

curl --location --request GET 'https://stream-api.productsup.com/streams/124773' \
--header 'Accept: application/vnd.api+json'

You can either list all Streams the user has access to or a specific, individual Stream.

The list of all Streams is paginated to a maximum of 10 Streams per page. To traverse the paginated list you can use the pagination links which can be found in the top-level links object of the response.

We support the following query parameters for traversing:

page[offset] - The offset determines the start record.

page[limit] - The limit determines the number of records to display.

We maintain from 1 to 10 Streams per page.

Update Stream

Update a specific Stream:

curl --location --request PATCH 'https://stream-api.productsup.com/streams/124773' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--data-raw '{
  "data": {
    "id": "124773",
    "type": "stream",
    "attributes": {
      "name": "My product Stream with an updated name"
    }
  }
}'

We only allow updating the name of a Stream.

Due to technical limitations, it's impossible to change the Stream type. If you need to change the type, we recommend you create a new Stream with the correct type and remove the old Stream.

If you have access to multiple accounts, you can't move the existing Stream to another account. If you need to move the Stream to another account, we recommend you create a new Stream in the new account.

Remove Stream

Remove a Stream:

curl --location --request DELETE 'https://stream-api.productsup.com/streams/124773'

Remove Streams if you no longer need them, or if a client needs to switch between the type of Streams. When you delete a stream, you are deleting all contained data as well. If you removed a client(s) while switching between Stream types, you must push the full catalog to the new Stream.

When you remove a Stream, all data inside the Stream is unrecoverable after deletion.

Stream Management

Stream creation

List Stream

Update Stream

Remove Stream

On this page