Circana · Schema

ReportDetail

Detailed report information

AnalyticsConsumer DataMarket ResearchRetailCPGPoint Of SaleConsumer InsightsBusiness Intelligence

Properties

Name Type Description
report_id string Unique report identifier
name string Report name
status string Report processing status
created_at string Report creation timestamp
completed_at string Report completion timestamp
category string Primary category for the report
report_type string Type of report
row_count integer Number of data rows in completed report
estimated_completion string Estimated completion time for processing reports
View JSON Schema on GitHub

JSON Schema

circana-reportdetail-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReportDetail",
  "title": "ReportDetail",
  "type": "object",
  "description": "Detailed report information",
  "properties": {
    "report_id": {
      "type": "string",
      "description": "Unique report identifier",
      "example": "rpt-500123"
    },
    "name": {
      "type": "string",
      "description": "Report name",
      "example": "Q1 2026 Beverage Market Review"
    },
    "status": {
      "type": "string",
      "description": "Report processing status",
      "enum": [
        "draft",
        "processing",
        "completed",
        "failed"
      ],
      "example": "completed"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Report creation timestamp",
      "example": "2026-04-01T10:00:00Z"
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Report completion timestamp",
      "example": "2026-04-01T10:03:00Z"
    },
    "category": {
      "type": "string",
      "description": "Primary category for the report",
      "example": "Beverages"
    },
    "report_type": {
      "type": "string",
      "description": "Type of report",
      "example": "market_review"
    },
    "row_count": {
      "type": "integer",
      "description": "Number of data rows in completed report",
      "example": 4523
    },
    "estimated_completion": {
      "type": "string",
      "format": "date-time",
      "description": "Estimated completion time for processing reports",
      "example": "2026-04-18T12:05:00Z"
    }
  }
}