Export - Initiates the export process of a report

Initiates the export process of an existing report.

post

Authorizations

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

embedfast-user-emailstringOptional

Optional User Email

Body

application/jsontext/jsonapplication/*+json

Class for export file.

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.

exportTypestring · 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 ExportType property.

isPaginatedbooleanOptional

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

filterstring | nullableOptional

bookmarkStatestring | 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 BookmarkState property.

pageNamestring | 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 PageName property.

visualNamestring | 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 VisualName property.

Responses

200

Success: Export process successfully initiated for the report.

text/plainapplication/jsontext/json

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

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

405

Method Not Allowed: User doesn't have enough access to perform this operation.

500

Internal Server Error: An unexpected server error occurred during the export process.

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /export HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 331

{
  "reportId": "28b4b970-b0f6-4dac-b070-e1e17747c8c9",
  "exportType": "pdf",
  "isPaginated": true,
  "filter": "TableName/ColumnName eq 'Value' and TableName/AnotherColumn gt 10",
  "bookmarkState": "string",
  "pageName": "string",
  "visualName": "string",
  "reportParameter": [
    {
      "name": "Parameter1",
      "value": "Value1"
    },
    {
      "name": "Parameter2",
      "value": "Value2"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "createdDateTime": "2025-09-01T04:25:53.598Z",
  "lastActionDateTime": "2025-09-01T04:25:53.598Z",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "reportName": "text",
  "status": 0,
  "percentComplete": 1,
  "resourceLocation": "text",
  "resourceFileExtension": "text",
  "expirationTime": "2025-09-01T04:25:53.598Z"
}