Circana · Schema

CategoryDetail

Detailed category information

AnalyticsConsumer DataMarket ResearchRetailCPGPoint Of SaleConsumer InsightsBusiness Intelligence

Properties

Name Type Description
category_id string Unique category identifier
name string Category name
description string Category description
parent_id string Parent category identifier
industry string Industry vertical
level integer Depth level in the category hierarchy
subcategories array Direct subcategories
data_coverage object Data availability and coverage information
View JSON Schema on GitHub

JSON Schema

liquid-data-category-detail-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/circana/refs/heads/main/json-schema/liquid-data-category-detail-schema.json",
  "title": "CategoryDetail",
  "description": "Detailed category information",
  "type": "object",
  "properties": {
    "category_id": {
      "type": "string",
      "description": "Unique category identifier",
      "example": "cpg-beverages"
    },
    "name": {
      "type": "string",
      "description": "Category name",
      "example": "Beverages"
    },
    "description": {
      "type": "string",
      "description": "Category description",
      "example": "All beverage categories including carbonated, juice, water, and energy drinks"
    },
    "parent_id": {
      "type": "string",
      "description": "Parent category identifier",
      "example": "cpg"
    },
    "industry": {
      "type": "string",
      "description": "Industry vertical",
      "example": "cpg"
    },
    "level": {
      "type": "integer",
      "description": "Depth level in the category hierarchy",
      "example": 2
    },
    "subcategories": {
      "type": "array",
      "description": "Direct subcategories",
      "items": {
        "type": "object",
        "properties": {
          "category_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "parent_id": {
            "type": "string"
          },
          "industry": {
            "type": "string"
          },
          "level": {
            "type": "integer"
          },
          "subcategory_count": {
            "type": "integer"
          }
        }
      }
    },
    "data_coverage": {
      "type": "object",
      "description": "Data availability and coverage information",
      "properties": {
        "pos_available": {
          "type": "boolean",
          "description": "Whether POS data is available"
        },
        "panel_available": {
          "type": "boolean",
          "description": "Whether consumer panel data is available"
        },
        "earliest_date": {
          "type": "string",
          "format": "date",
          "description": "Earliest available data date"
        },
        "latest_date": {
          "type": "string",
          "format": "date",
          "description": "Latest available data date"
        }
      }
    }
  }
}