Excel reports

Describes the process and endpoints for the generation and download of Assess Excel reports

The Excel reports endpoints are used to produce and download excel reports. For more information on available reports, see the report types section.

The process to download an Excel report is:

  1. Request an Excel report for download.
  2. Check the progress status of the latest report requested (optional).
  3. Download the latest Excel report.

Only one request will be processed at a time per SMB company and per report type. The generated report is kept in blob storage and gets replaced when a new one is generated.

Available report types

Parameters

For each of the endpoints described below, you will provide the same parameters.

Parameter

Type

Description

Required

companyId

string

The company ID for which you want to produce an Excel report for download.

Required

reportType

string

The type of report you want to generate and download.

  • “audit”

Required

Request an Excel report for download

The endpoint is available in Swagger under Assess.

POST /data/companies/{companyId}/assess/excel

Field

Type

Description

lastGenerated

string
See date

The date and time of the report that is being generated.

inProgress

boolean

  • true - the request was successful and the report is being generated.
  • false - the request was unsuccessful and the report is not being generated.

queued

string
See date

The time a successful request was queued.

success

boolean

  • true - the requested report was successfully queued.
  • false - the requested report wasn’t able to be queued.

errorMessage

string

The error message if the status was unsuccessful.

lastInvocationId

string

A unique ID generated for this request.

reportType

string

The report requested in the query string.

Example

{
  "lastGenerated": "2022-10-18T12:43:33.340Z",
  "inProgress": true,
  "queued": "2022-10-18T12:43:33.340Z",
  "success": true,
  "errorMessage": "string",
  "lastInvocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportType": "string"
}

Check status of the report

The status tells you if the last report requested is complete. It only returns the status of the last report requested, not for older requests. This step is optional and won't affect the generation of the report if it were skipped.

When the report is complete, the inProgress field will have the value of false whilst the success field will show true.

The endpoint is available in Swagger under Assess.

GET /data/companies/{companyId}/assess/excel

Field

Type

Description

lastGenerated

string
See date

The date and time of the report that is being generated.

inProgress

boolean

  • true - the request was successful and the report is being generated.
  • false - the request was unsuccessful and the report is not being generated.

queued

string
See date

The time a successful request was queued.

success

boolean

  • true - the requested report was successfully queued.
  • false - the requested report wasn’t able to be queued.

errorMessage

string

The error message if the status was unsuccessful.

lastInvocationId

string

A unique ID generated for this request.

reportType

string

The report requested in the query string.

Example

{
  "lastGenerated": "2022-10-18T12:44:46.081Z",
  "inProgress": true,
  "queued": "2022-10-18T12:44:46.081Z",
  "success": true,
  "errorMessage": "string",
  "lastInvocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportType": "string"
}

Download the report

The endpoint is available in Swagger under Assess.

POST /data/companies/{companyId}/assess/excel/download

The downloadable Excel file is available in the response. Click it to save to your local machine.


Read next