Request status of the report using jobId

Rate limit: 32 requests per minute.

get/v1/reports/{jobId}

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesreports.generate_report
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/reports/:jobId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

jobIdstring required

ID used to track the job created for generating report.

Example:38ab397f-b142-4b06-b70c-40c68a408bea

Response

Report is found

status'IN_PROGRESS' | 'READY' | 'ERROR' | 'EXPIRED'

Report export status

Example response

{
  "payload": {
    "reportUrl": "https://example.com/path/to/report.csv.gz",
    "errorMessage": "Report generation error. Please reach out to support and provide jobId"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.