Circana · Schema

Pagination

Pagination metadata

AnalyticsConsumer DataMarket ResearchRetailCPGPoint Of SaleConsumer InsightsBusiness Intelligence

Properties

Name Type Description
offset integer Current offset position
limit integer Maximum records per page
total integer Total number of records available
View JSON Schema on GitHub

JSON Schema

circana-pagination-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Pagination",
  "title": "Pagination",
  "type": "object",
  "description": "Pagination metadata",
  "properties": {
    "offset": {
      "type": "integer",
      "description": "Current offset position",
      "example": 0
    },
    "limit": {
      "type": "integer",
      "description": "Maximum records per page",
      "example": 100
    },
    "total": {
      "type": "integer",
      "description": "Total number of records available",
      "example": 4523
    }
  }
}