Report Generation Status

Get the current status of a report.

Url Parameters

• companyid – Your company id.
• reportid – The id of the report you are checking.

Get the status of a report. This request will return following HTTP statuses:

• 200 - Report is still being generated.
• 303 - Report has been generated and Location: header contains the URL to obtain the report data. Body of response will contain one or more URLs pointing to parts of generated report (see option maxrowsperfile in "POST api/report/insights/v2/{companyid}/reports"). If multiple files are generated Location header will point to the first part. Please note: some tools/libraries will by default automatically fetch URL provided in Location header field so report (or only the first part in case of multiple files) will be automatically downloaded. Please consult documentation for tool/library in use how this behavior can be disabled.
• 404 - Report does not exist.
• 503 - Report failed.

Sample Request

GET api/report/insights/v2/{companyid}/reports/status/{reportid}

Sample Response

Single file (without "maxrowsperfile" option):

HTTP 303 See Other
Location: https://<randomizedstorageurl>/filename.csv
{
  "url": [
    "https://<randomizedstorageurl>/filename.csv"
  ]
}

Multiple files (with "maxrowsperfile" option):

HTTP 303 See Other
Location: https://<randomizedstorageurl>/filename Part 1 of 3.csv
{
  "url": [
    "https://<randomizedstorageurl>/filename Part 1 of 3.csv",
    "https://<randomizedstorageurl>/filename Part 2 of 3.csv",
    "https://<randomizedstorageurl>/filename Part 3 of 3.csv"
  ]
}