Query a stream

GET

/content/delivery/v1/streams/{externalId}

const url = 'https://api.ebitex.io/content/delivery/v1/streams/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/content/delivery/v1/streams/example \
  --header 'Authorization: Bearer <token>'

Returns one page of a stream: a named listing an editor defines, with its own sources, order and filters. externalId is the stream’s external id or id.

Items always carry content and paths. When the stream maps its items through an Adapter, content is the Adapter’s output and contract names the output contract.

filter.<key>= takes values for the filters the stream declares. Repeated values of one key match any of them; different keys must all match. A full-text filter takes one value, with quoted phrases, OR and -word.

Key: a delivery key (content.delivery.read).

Authorizations

apiKey

Parameters

Path Parameters

externalId

required

string

Query Parameters

site

string format: uuid

limit

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

cursor

string

locale

string

ctx

string

include

Array<string>

Responses

200

400

validation_failed: a filter the stream does not declare. unknown_category: no category has this path or id. category_not_in_group: the category belongs to a different group from the one the filter is scoped to. invalid_cursor: the cursor is malformed or the stream’s order has changed; restart from the first page.

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

403

scope_denied: the key lacks this route’s scope. origin_denied or ip_denied: a browser-safe key was used from an origin or address outside its restrictions. app_not_available: Content is not enabled for the organization.

404

unknown_stream: no stream has this external id or id.

429

Quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.