Sign in to run requests with your own sandbox key. Sign in

StaticCollectionMeta

Meta for collections that are NOT paginated (artifact lists). The whole collection is always returned in one response and the `page` / `per_page` query parameters are ignored. The pagination fields are still present for shape compatibility but hold constant values: `page` is always 1, `total_pages` is always 1, and `per_page` equals `total_count`.

Type: Meta

StaticCollectionMeta has 6 top-level fields; request_id, object, total_count are always present. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 2 operations, listed under Used by. The machine-readable definition is #/components/schemas/StaticCollectionMeta in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.
  • object string required
  • total_count integer required Number of items in `data`.
  • page integer Always 1. One of 1
  • per_page integer Always equal to `total_count`.
  • total_pages integer Always 1. One of 1

Used by

Was this page helpful?