Circana · Example Payload

Circana Getcategory Example

AnalyticsConsumer DataMarket ResearchRetailCPGPoint Of SaleConsumer InsightsBusiness Intelligence

Circana Getcategory Example is an example object payload from Circana, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "getCategory",
  "method": "GET",
  "path": "/categories/{category_id}",
  "summary": "Circana Get Category Details",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "GetCategory200Example",
      "example": {
        "category_id": "cpg-beverages",
        "name": "Beverages",
        "description": "All beverage categories including carbonated, juice, water, and energy drinks",
        "parent_id": "cpg",
        "industry": "cpg",
        "level": 2,
        "subcategories": [
          {
            "category_id": "cpg-beverages-carbonated",
            "name": "Carbonated Beverages"
          }
        ],
        "data_coverage": {
          "pos_available": true,
          "panel_available": true,
          "earliest_date": "2018-01-01",
          "latest_date": "2026-03-31"
        }
      }
    }
  ]
}