ReportReadyPayload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/doordash/refs/heads/main/json-schema/doordash-report-ready-payload-schema.json",
  "title": "ReportReadyPayload",
  "description": "ReportReadyPayload schema from DoorDash API",
  "type": "object",
  "properties": {
    "report_id": {
      "type": "string",
      "description": "The unique identifier for the report.",
      "example": "D-12345"
    },
    "report_type": {
      "type": "string",
      "description": "The type of report that was generated.",
      "enum": [
        "financial",
        "operations",
        "menu",
        "feedback"
      ],
      "example": "financial"
    },
    "status": {
      "type": "string",
      "description": "The report processing status.",
      "enum": [
        "SUCCEEDED",
        "FAILED"
      ],
      "example": "SUCCEEDED"
    },
    "download_url": {
      "type": "string",
      "format": "uri",
      "description": "A temporary URL to download the report. Only present when status is SUCCEEDED.",
      "example": "https://example.com/path/abc123"
    },
    "error_message": {
      "type": "string",
      "description": "Error details if report generation failed. Only present when status is FAILED.",
      "example": "example"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the report request was originally created.",
      "example": "2026-06-02T14:30:00Z"
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the report generation completed.",
      "example": "2026-06-02T14:30:00Z"
    }
  }
}