POST
/
api
/
v2
/
dataApp
/
dashboards
Data App Dashboards
curl --request POST \
  --url https://api.usedatabrain.com/api/v2/dataApp/dashboards \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "embedId": "<string>",
  "clientId": "<string>",
  "isPagination": true,
  "pageNumber": 123
}'

​
Cloud Databrain Endpoint

POST https://api.usedatabrain.com/api/v2/dataApp/dashboards

​
Self-hosted Databrain Endpoint

POST <SELF_HOSTED_URL>/api/v2/dataApp/dashboards

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
Request Body

​
embedId
string
required
​
clientId
string
required
​
isPagination
boolean
​
pageNumber
number

​
Error Codes

  • INVALID_DATA_APP_API_KEY: Invalid or missing Data App API Key
  • INVALID_REQUEST_BODY: Required fields missing or wrong type
  • EMBED_PARAM_ERROR: Embed ID not found or mismatched with API Key

​
Validation Schema

The request body must conform to the following schema:
  • embedId (required): embedId of the data app; embedID.
  • clientId (required): client id.
  • isPagination (optional): Boolean flag to enable pagination.
  • pageNumber (optional): Page number when pagination is enabled.