Get Documents of Stream

Retrieves documents associated to a given stream.

Returns the documents currently assigned to a stream for a specific language index. Useful for previewing or auditing which products are in a stream.

Requires authentication.

Request

GET /stream/documents/{streamId}/{languageId}

Path Parameters

ParameterTypeRequiredDescription
streamIdintegerYesThe ID of the stream.
languageIdstringYesThe language identifier for the index (e.g. de, en).

Headers

HeaderValue
AuthorizationBearer <token>

Request Body (optional)

FieldTypeDefaultDescription
sortingstringidField to sort results by.
orderstringdescSort order: asc or desc.
countinteger50Number of documents to return per page.
offsetinteger0Pagination offset.

Example Request

GET /stream/documents/3/de
Authorization: Bearer <token>

Response

Returns a JSON array of document objects assigned to the stream.

Example Response

[
  {
    "id": "product-123",
    "title": "Running Shoes XR",
    "price": 89.99
  },
  {
    "id": "product-456",
    "title": "Trail Running Boots",
    "price": 119.99
  }
]
Path Params
integer
required
string
required
Body Params
string

Define, which field is sorted by. Default is id

string

The order to apply to the sorting. Can be either "asc" or "desc". Default is desc.

integer

Number of products to be returned in the response. Default is 50.

integer

The offset to start returning products from. In combination with the "count" property this is used for paginating the search results. Default is 0.

Headers
string
required

Makaira Instance ID

Responses
200

List of documents

404

Stream Not Found

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!