Request report generation

POST /api/v1/integrations/{integrationId}/reports/{report}

Request a report from your Hype Reports client, then poll the returned pollUrl for its status and result. HES handles report generation asynchronously.

Supported reports: operator-revenue (user_ids, max 31 days), revenue-by-menu (menu_ids, max 31 days), revenue-by-fiscal-device (fiscal_device_ids, max 31 days), revenue-by-main-category (main_category_ids, max 31 days), revenue-by-category (category_ids, max 31 days), and orders-summary (user_ids, saloon_ids, table_ids, max 1 day). Ranges are compared in whole days with the remainder dropped. A slug that is not in the HES report catalog returns 404. Filter IDs must be Hype Reports IDs mapped by sync tasks. HES omits unmapped IDs; if none remain, no filter is applied for that entity type.

Request

POST https://es.dev.hype-software.com/api/v1/integrations/{integrationId}/reports/{report}
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
Content-Type: application/json

Request body

{
  "date_from": "2026-07-08T00:00:00.000Z",
  "date_to": "2026-07-08T23:59:59.000Z",
  "user_ids": ["hr-user-7"],
  "saloon_ids": ["hr-saloon-10"],
  "table_ids": ["hr-table-20"]
}

Path parameters

Parameter	Example
integrationId	Your integrationId
report	Your report

Response examples

202 · Request report generation

{
  "jobId": "a0ffc461-33b6-4dcc-b916-1932f339b1f4",
  "pollUrl": "https://es.dev.hype-software.com/api/v1/report-data/a0ffc461-33b6-4dcc-b916-1932f339b1f4",
  "message": "Report request accepted and queued for processing"
}