report

Retrieve report generation status

Changed on

Retrieve report generation status by report ID

get/report/{reportId}/status

Request

  • Base URL
    https://services.sheerid.com/rest/v2
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Unique identifier of Report to retrieve

Response

Information indicating whether the report is ready for download yet, or not.

idstring
status'PENDING' | 'COMPLETE' | 'ERROR' | 'DELETED'
statusUrlstring uri
retrievalUrlstring uri nullable

The URL to download the completed report from. The value is null until the status of the report becomes COMPLETE.

requesterstring
createdinteger

Changes