Export - Initiate the export process of an existing 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 · 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.

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.

isPaginatedbooleanRequired

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

Indicates successfull initialization of export process

text/plainapplication/jsontext/json

400

Indicates user doesn't have asset assigned

401

Un-authorized request

text/plainapplication/jsontext/json

404

Indicates report Id does not exist

text/plainapplication/jsontext/json

405

Indicates user doesn't have enough access to perform this operation

500

Server related error

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

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

{
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "exportType": "text",
  "isPaginated": true,
  "filter": "text",
  "bookmarkState": "text",
  "pageName": "text",
  "visualName": "text",
  "reportParameter": [
    {
      "name": "text",
      "value": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "createdDateTime": "2025-06-06T14:22:47.902Z",
  "lastActionDateTime": "2025-06-06T14:22:47.902Z",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "reportName": "text",
  "status": 0,
  "percentComplete": 1,
  "resourceLocation": "text",
  "resourceFileExtension": "text",
  "expirationTime": "2025-06-06T14:22:47.902Z"
}