Skip to main content
API docs by Redocly

Reporting APIs (1.0.0)

Request Report

Request Body schema: application/json
business_ids
Array of integers
store_ids
Array of integers
report_type
required
string
Enum: "CONSUMER_FEEDBACK" "MENU_ITEM_ERROR" "MENU_OPEN_HOURS" "MENU_SPECIAL_HOURS" "ORDER_DETAIL" "PAYOUT_SUMMARY" "TRANSACTION_DETAIL" "TEMPORARY_DEACTIVATION" "AVOIDABLE_WAIT" "CANCELLED_ORDERS" "NV_PAYMENTS" "NV_TRANSACTIONS" "NV_ORDER_ITEMS"
start_date
required
string([0-9]{4})-(?:[0-9]{2})-([0-9]{2})
end_date
required
string([0-9]{4})-(?:[0-9]{2})-([0-9]{2})
webhook_url
string(https:\/\/.)[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[...

Responses

Request samples

Content type
application/json
{
  • "business_ids": [
    ],
  • "store_ids": [
    ],
  • "report_type": "CONSUMER_FEEDBACK",
  • "start_date": "2021-12-10",
  • "end_date": "2021-12-11",
  • "webhook_url": "https://yourdomain.com/callback"
}

Response samples

Content type
application/json
{
  • "report_id": "3aae518c-0772-4842-9de8-14e0921c5c7d"
}