POST
/
api
/
v2
/
dataApp
/
dashboards
{
  "isPagination": "boolean (optional)",
  "pageNumber": "number (optional)"
}
{
  "data": [
    {
      "name": "string",
      "externalDashboardId": "string"
    }
  ],
  "error": null
}

Endpoint:

POST /dashboards

Headers

Authorization
string
required
Bearer API TOKEN

Request Body

embedid
string
required
clientid
string
required
isPagination
boolean
pageNumber
number
{
  "isPagination": "boolean (optional)",
  "pageNumber": "number (optional)"
}

Response

{
  "data": [
    {
      "name": "string",
      "externalDashboardId": "string"
    }
  ],
  "error": null
}

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.