Circana · Schema

CreateExportRequest

Request to create a data export

AnalyticsConsumer DataMarket ResearchRetailCPGPoint Of SaleConsumer InsightsBusiness Intelligence

Properties

Name	Type	Description
source_type	string	Type of data source to export
source_id	string	Identifier of the data source
format	string	Export file format
include_headers	boolean	Whether to include column headers

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateExportRequest",
  "title": "CreateExportRequest",
  "type": "object",
  "description": "Request to create a data export",
  "required": [
    "source_type",
    "source_id",
    "format"
  ],
  "properties": {
    "source_type": {
      "type": "string",
      "description": "Type of data source to export",
      "enum": [
        "report",
        "query",
        "dataset"
      ],
      "example": "report"
    },
    "source_id": {
      "type": "string",
      "description": "Identifier of the data source",
      "example": "rpt-500123"
    },
    "format": {
      "type": "string",
      "description": "Export file format",
      "enum": [
        "csv",
        "xlsx",
        "json",
        "parquet"
      ],
      "example": "csv"
    },
    "include_headers": {
      "type": "boolean",
      "description": "Whether to include column headers",
      "default": true,
      "example": true
    }
  }
}