Otter · JSON Structure

Public Api Report Generated Event Structure

Event data containing metadata of the generated report

Type: object Properties: 2
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

ReportGeneratedEvent is a JSON Structure definition published by Otter, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

reportUrl jobId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-report-generated-event-structure.json",
  "name": "ReportGeneratedEvent",
  "description": "Event data containing metadata of the generated report",
  "type": "object",
  "properties": {
    "reportUrl": {
      "type": "string",
      "description": "Public URL to download generated report",
      "example": "https://example.com/"
    },
    "jobId": {
      "type": "string",
      "description": "Job id as returned by /v1/reports call",
      "example": "38ab397f-b142-4b06-b70c-40c68a408bea"
    }
  }
}