Get stream usage

Returns a list of entities (e.g. landing pages, categories) that are currently using a given stream.

Requires the stream:usage:read or streams.read permission.

Request

GET /stream/{id}/usage

Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe ID of the stream to check usage for.

Headers

HeaderValue
AuthorizationBearer <token>

Query Parameters

ParameterTypeRequiredDescription
typestringYesThe usage type to filter by. Accepted values: landingpage.

Example Request

GET /stream/5/usage?type=landingpage
Authorization: Bearer <token>

Response

Returns a JSON array of entities that use this stream.

Example Response

[
  {
    "id": 12,
    "title": "Summer Sale Landing Page"
  }
]