Query Items

Retrieves a list of items, given the provided paging, filtering, and sorting.

Query Items runs with these defaults, which you can override:

• paging.limit is 50
• paging.offset is 0

Query Items supports a fixed set of filterable fields:

• status: PUBLISHED, SCHEDULED, DRAFT, FAILED, CANCELED, PROCESSING, or IN_QUEUE.
• channel: a channel name, such as FACEBOOK or INSTAGRAM.
• type: POST, STORY, REEL, VIDEO, or SHORT.
• mediaType: IMAGE or VIDEO.
• suggested: true or false.
• ids: a list of item IDs.

Each of these supports the $eq and $in operators, and a bare value as shorthand for $eq, except for ids, which supports $in only. Enum values are case insensitive. A value that the API doesn't define matches no items rather than returning an error, and a field that isn't listed above is ignored rather than rejected, so a filter on an unsupported field returns the same items as no filter at all.

Sorting is supported on these fields:

• date: the default. Newest first, unless you specify order.
• impressionsTotal, impressions, interactions, and siteVisits: require the site to have post insights. Without them, the items are sorted by date instead, in whichever direction you specified.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.