Skip to main content
POST
This endpoint generates a JWT token for accessing a dashboard with a SharePolicy. The token can include custom parameters, expiration dates, and URL parameter permissions.

Parameters

string
required
The ID of the dashboard/project

Body Parameters

object
Share policy configuration to update before generating token
string
Token expiration date and time in ISO 8601 format (e.g., “2024-12-31T23:59:59Z”)

Response

string
The generated JWT access token for dashboard access
string
The complete shareable URL with the access token included

Example

Usage Notes

  • Prerequisites: A SharePolicy must exist for the project before generating tokens. Use the “Create Dashboard Share Policy” endpoint first.
  • Token Expiration: If no expiration is specified, the token will have a very long expiration (99999 days).
  • Parameters: Parameters defined in the share policy will be passed as variables to the dashboard’s charts.
  • URL Parameters: If allow_params is true, additional parameters can be passed via URL query parameters and will override policy parameters.
  • Security: Always use HTTPS when sharing URLs containing access tokens.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the project

Body

application/json
share_policy
object
exp
string<date-time>

Token expiration date and time

Response

Generated share token and URL

token
string

The generated JWT access token

url
string

The complete URL with access token for sharing