Embed Token - Generate embed token for reports

Generates an embed token for reports.

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

embedfast-user-emailstringOptional

Optional User Email

Body

application/jsontext/jsonapplication/*+json

Class for storing details of an embed config report.

reportIdsstring · uuid[] · nullableOptional

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

datasetIdsstring · uuid[] · nullableOptional

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

Responses

200

Success: Embed token successfully generated for the report.

text/plainapplication/jsontext/json

Class for representing embed token response.

tokenstring · 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 Token property.

tokenIdstring · 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 TokenId property.

expirationstring · date-timeOptional

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

datasetWithRlsstring · uuid[] · nullableOptional

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

warningMessagestring · 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 WarningMessage property.

400

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

text/plainapplication/jsontext/json

403

Forbidden: Access denied to generate an embed token for the report due to insufficient permissions or account restrictions.

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

/reports/generateEmbedToken

HTTPcURLJavaScriptPython

POST /reports/generateEmbedToken HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "reportIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "datasetIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "token": "text",
  "tokenId": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-02-23T09:53:08.226Z",
  "datasetWithRls": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "warningMessage": "text"
}