Clari · Schema

ClariForecastExportRequest

Request body for creating a Clari forecast export job.

Revenue OperationsForecastingPipeline ManagementSales IntelligenceActivity IntelligenceDeal InsightsCRMConversation IntelligenceB2BEnterprise

Properties

Name	Type	Description
timePeriod	string	Fiscal quarter for the export, formatted as YYYY_QQ.
scopeId	string	Identifier to restrict the export to a particular organizational scope.
typesToExport	array	Forecast data types to include in the export.
currency	string	ISO 4217 currency code for monetary value normalization.
exportFormat	string	Output format for the export file.
includeHistorical	boolean	Whether to include historical forecast submissions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.clari.com/schemas/forecast-export-request",
  "title": "ClariForecastExportRequest",
  "description": "Request body for creating a Clari forecast export job.",
  "type": "object",
  "properties": {
    "timePeriod": {
      "type": "string",
      "description": "Fiscal quarter for the export, formatted as YYYY_QQ.",
      "example": "2024_Q3",
      "default": "current quarter"
    },
    "scopeId": {
      "type": "string",
      "description": "Identifier to restrict the export to a particular organizational scope."
    },
    "typesToExport": {
      "type": "array",
      "description": "Forecast data types to include in the export.",
      "items": {
        "type": "string",
        "enum": ["forecast", "call", "best_case", "pipeline", "closed"]
      }
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code for monetary value normalization.",
      "example": "USD"
    },
    "exportFormat": {
      "type": "string",
      "description": "Output format for the export file.",
      "enum": ["JSON", "CSV"],
      "default": "JSON"
    },
    "includeHistorical": {
      "type": "boolean",
      "description": "Whether to include historical forecast submissions.",
      "default": false
    }
  }
}