loading

Streams: Get

Retrieve records by ID from a Streams Endpoint

path Parameters
accountId
required
string
endpoint
required
string

The ID of the Streams Endpoint to query.

ids
required
Array of strings

The Streams records to get. Multiple record IDs can be provided separated by commas.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Streams: List

List records from a Streams Endpoint

In addition to the parameters above, users can filter on the content of fields defined in the endpoint's field indexes.

For example, with the parameter name=Alice, only records where the field name has value Alice will be returned.

Similarly, adding the parameters name__in=Alice and name__in=Bob will result in records with name equal to Alice or Bob being returned.

Multiple filters on different fields and different filter types can be combined in the same query. When filtering on a field that contains more than one value (an array field) the filter will be satisfied if any value in the array matches the filter.

path Parameters
accountId
required
string
endpoint
required
string

The ID of the Streams Endpoint to query.

query Parameters
v
required
string

A date in YYYYMMDD format.

limit
integer <= 50
Default: 10

Number of results to return.

pageToken
string

If a response to a previous request contained the nextPageToken field, pass that field's value as the pageToken parameter to retrieve the next page of data.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}