Embed Token - Generates an embed token for a dashboard

Generates an embed token for a dashboard.

post

Authorizations

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 representing the configuration for embedding a dashboard.

dashboardIdstring · 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 DashboardId property.

Responses

200

Success: Successfully generated the embed token.

text/plainapplication/jsontext/json

404

Not Found: The dashboard 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

HTTPcURLJavaScriptPython

POST /dashboards/generateEmbedToken HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "dashboardId": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "token": "text",
  "tokenId": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-06-01T06:13:25.792Z"
}