โน๏ธToken
To obtain a guest token from DataBrain, utilize our REST API from your backend system. Each request will generate a unique guest token, ensuring security and flexibility.
Once you acquire the guest token, you can seamlessly pass it to your frontend application, where it can be integrated with the web component.
Create API key from Databrain's dashboard
that should be passed in the headers in these requests.
Quick start (simple use case):
Quick start (simple use case):
When you need a guest token that you want to use across dashboards and metrics. All you have to do is pass clientId, workspaceName. If expiryTime is not passed, the token will not expire.
Cloud Databrain:
POST
https://api.usedatabrain.com/api/v1/guest-token/create
Self-hosted Databrain:
POST
<SELF_HOSTED_URL>/api/v1/guest-token/create
Generating GUEST TOKEN for your Dashboard/Metric Component.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer API TOKEN |
Request Body
Name | Type | Description |
---|---|---|
workspaceName* | String | Your Workspace Name |
clientId* | String | Client ID for whom this guest token is generated. |
params | Object | Additional Params: dashboard appFilters |
expiryTime | Number | In milli seconds |
when the response is successful it returns a token that you can pass to the frontend.
Request Body Examples:
Simple Request Body:
Request Body with Dashboard Specified:
Request Body with App Level Metric Filter:
A sample Postman Collection:
Dashboard App Filters:
Request Body with Dashboard filters:
When you disable the isShowOnUrl
the filter will not visible to end user as search params on URL.
Error Codes:
'AUTHENTICATION_ERROR'
'INVALID_REQUEST_BODY'
'CLIENT_ID_ERROR'
'WORKSPACE_ID_ERROR'
'DASHBOARD_PARAM_ERROR'
'APP_FILTER_PARAM_ERROR'
'RLS_SETTINGS_PARAM_ERROR'
'INTERNAL_SERVER_ERROR'
Last updated