Download Inspection Report

GET /reports/inspections/:id/download

This report returns all the information about a specific inspection as an XLSX document.

Path parameters

  • id: The created timestamp of the Inspection you want to export.

Parameters

All query parameters are optional.

  • group_by: Defines how the items in the report should be grouped. One of "category" or "account_code".
  • lang: The language of the report excel. One of "en" or "de".
  • timezone_offset: the local time zone offset for the client. In order to have the dates and times shown in the downloaded report correctly, this should be sent. Otherwise it defaults to 0 and represents all dates and times in UTC.

Status codes

  • 200 on success
  • 404 if the inspection was not found

Response properties

The response is a download url for the generated xlsx report.

  • url: The URL where the report can be accessed.

Example response:

{
  "url": "https://s3.eu-central-1.amazonaws.com/exports.yourbarmate.com/c6a61b00-178f-4604-a51b-927cb9b4e302/inspection-report-1730205514020.xlsx"
}

The report is generated fresh every time you request it.