List Streams

List all Streams

Returns a list of all streams configured for the current instance. Streams define collections of documents (e.g. products) with optional boost factors, used for category boosting and product listings.

Requires authentication.

Request

GET /stream

Headers

HeaderValue
AuthorizationBearer <token>

Response

Returns a JSON array of stream objects.

Response Body

FieldTypeDescription
idintegerUnique stream ID.
titlestringDisplay title of the stream.
boostFactornumberBoost factor applied to items in this stream. Range: -99 to 99. 0 means no boosting.

Example Response

[
  {
    "id": 1,
    "title": "Featured Products",
    "boostFactor": 50
  },
  {
    "id": 2,
    "title": "Clearance Items",
    "boostFactor": -20
  }
]
Headers
string
required

Makaira Instance ID

Response
200

OK

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