Export - Fetch status of export-related details

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

post

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Body

application/jsontext/jsonapplication/*+json

Class for export status request parameters.

reportIdstring · uuidOptional

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.

paginatedAssetIdstring · uuid · nullableOptional

Gets or sets the unique identifier for the paginated asset. Required in case of Paginated visual export (type 2) MAQ.BIHub.API.Model.ExportMethod

Responses

200

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

text/plainapplication/jsontext/json

Class for export status.

idstring · nullableOptional

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 Id property.

createdDateTimestring · date-time · nullableOptional

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

lastActionDateTimestring · date-time · nullableOptional

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

reportIdstring · uuid · nullableOptional

A public property of type nullable 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.

reportNamestring · nullableOptional

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 ReportName property.

statusstring · nullableOptional

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 Status property.

percentCompleteinteger · int32 · nullableOptional

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

resourceLocationstring · nullableOptional

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 ResourceLocation property.

resourceFileExtensionstring · nullableOptional

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 ResourceFileExtension property.

expirationTimestring · date-time · nullableOptional

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

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

404

Not Found: The report was not found, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

post

/exportStatus

HTTPcURLJavaScriptPython

POST /exportStatus HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "exportId": "text",
  "paginatedAssetId": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "createdDateTime": "2026-02-23T14:03:59.658Z",
  "lastActionDateTime": "2026-02-23T14:03:59.658Z",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "reportName": "text",
  "status": "text",
  "percentComplete": 1,
  "resourceLocation": "text",
  "resourceFileExtension": "text",
  "expirationTime": "2026-02-23T14:03:59.658Z"
}