Skip to main content
POST
List stock items matching a dynamic filter

Query Parameters

apiKey
string
required

Body

application/json

Every part is optional. An empty object returns the first page of the subscriber's stock items.

Which rows to match, how to sort them, which fields to return and which page to read.

filters
object

A set of clauses and nested groups joined by one operator. Groups may nest two levels deep and carry at most 20 clauses in total.

timeRange
object

Shorthand window over the dataset's defaultDateFieldId. Supply either a preset or both from and to, never both. Windows are half-open in UTC: from is included, to is not.

sort
object[] | null

At most two rules. The dataset's unique key always breaks ties, so paging is stable.

fields
string[] | null

Field ids to return. Omit for every field in the dataset's catalog.

start
integer<int32>
default:0

Rows to skip. Defaults to 0.

rows
integer<int32> | null
default:100

Page size, between 1 and 1000. Defaults to 100.

Response

OK

count
integer<int32>

Total rows matching the filter, not the number returned.

start
integer<int32>
rows
integer<int32>

Page size the query ran with.

items
object[]

One object per row, keyed by field id, holding only the requested fields. A field with no value is null.