Circana · Schema

CreateReportRequest

Request to create a new report

AnalyticsConsumer DataMarket ResearchRetailCPGPoint-of-SaleConsumer InsightsBusiness Intelligence

Properties

Name Type Description
name string Report name
report_type string Type of report to generate
category_id string Product category for the report
start_date string Report start date
end_date string Report end date
geography string Geographic scope
metrics array Metrics to include in the report
View JSON Schema on GitHub

JSON Schema

circana-createreportrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateReportRequest",
  "title": "CreateReportRequest",
  "type": "object",
  "description": "Request to create a new report",
  "required": [
    "name",
    "report_type",
    "category_id",
    "start_date",
    "end_date"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Report name",
      "example": "Q1 2026 Snacks Performance"
    },
    "report_type": {
      "type": "string",
      "description": "Type of report to generate",
      "enum": [
        "market_review",
        "brand_performance",
        "category_analysis",
        "competitive_landscape",
        "pricing_analysis"
      ],
      "example": "market_review"
    },
    "category_id": {
      "type": "string",
      "description": "Product category for the report",
      "example": "cpg-snacks"
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "Report start date",
      "example": "2026-01-01"
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "Report end date",
      "example": "2026-03-31"
    },
    "geography": {
      "type": "string",
      "description": "Geographic scope",
      "example": "national"
    },
    "metrics": {
      "type": "array",
      "description": "Metrics to include in the report",
      "items": {
        "type": "string"
      },
      "example": [
        "dollar_sales",
        "unit_sales",
        "market_share"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/circana-createreportrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.