Export - Retrieves the status of export-related details for a report

Retrieves the status of export-related details for a report.

post

Authorizations

Query parameters

versionstring · default: "1.0"optional

The requested API version

Header parameters

embedfast-user-idstringoptional

Optional User Id

Body

application/jsontext/jsonapplication/*+json

reportIdstring · uuidrequired

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportId property.

exportIdstring · min: 1required

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ExportId property.

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/exportStatus' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "reportId": "123e4567-e89b-12d3-a456-426614174000",
    "exportId": "text"
  }'

application/jsontext/jsonapplication/*+json

200

401

404

500

200

text/plain

application/json

text/json

text/plain

{
  "id": "text",
  "createdDateTime": "2025-04-03T02:31:02.574Z",
  "lastActionDateTime": "2025-04-03T02:31:02.574Z",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "reportName": "text",
  "status": "text",
  "percentComplete": 1,
  "resourceLocation": "text",
  "resourceFileExtension": "text",
  "expirationTime": "2025-04-03T02:31:02.574Z"
}

Success: Returns the status of export-related details of an existing report.