doordash · Schema

ReportLinkResponse

ReportLinkResponse schema from DoorDash API

Properties

Name Type Description
report_id string The unique identifier for the report.
status string The current processing status of the report.
download_url string A temporary URL to download the report. Only present when status is SUCCEEDED.
report_type string The type of report that was generated.
created_at string When the report request was created.
completed_at string When the report generation was completed. Only present when status is SUCCEEDED.
View JSON Schema on GitHub

JSON Schema

doordash-report-link-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/doordash/refs/heads/main/json-schema/doordash-report-link-response-schema.json",
  "title": "ReportLinkResponse",
  "description": "ReportLinkResponse schema from DoorDash API",
  "type": "object",
  "properties": {
    "report_id": {
      "type": "string",
      "description": "The unique identifier for the report.",
      "example": "D-12345"
    },
    "status": {
      "type": "string",
      "description": "The current processing status of the report.",
      "enum": [
        "PENDING",
        "PROCESSING",
        "SUCCEEDED",
        "FAILED"
      ],
      "example": "PENDING"
    },
    "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"
    },
    "report_type": {
      "type": "string",
      "description": "The type of report that was generated.",
      "enum": [
        "financial",
        "operations",
        "menu",
        "feedback"
      ],
      "example": "financial"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the report request was created.",
      "example": "2026-06-02T14:30:00Z"
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the report generation was completed. Only present when status is SUCCEEDED.",
      "example": "2026-06-02T14:30:00Z"
    }
  }
}