POST
/
api
/
v2
/
dataApp
/
query
{
  "embedId": "string", // required
  "metricId": "string", // required
  "clientId": "string", // required
  "datasourceName": "string", // optional, only for multi-datasource workspaces
  "dashboardFilter": {
    // globalFilters object structure
  },
  "metricFilter": [
    // rlsConditions array structure
  ]
}
{
  "data": [
    {}, 
    {}
  ],
  "timeTaken": 106,
  "metaData": {
    "groupbyColumnList": []
  }
}

Endpoint:

POST /api/v2/dataApp/query

Headers

Authorization
string
required
Bearer API TOKEN

Request Body

embedId
string
required
metricId
string
required
clientId
string
required
datasourceName
string
dashboardFilter
object
metricFilter
array
{
  "embedId": "string", // required
  "metricId": "string", // required
  "clientId": "string", // required
  "datasourceName": "string", // optional, only for multi-datasource workspaces
  "dashboardFilter": {
    // globalFilters object structure
  },
  "metricFilter": [
    // rlsConditions array structure
  ]
}

Response

{
  "data": [
    {}, 
    {}
  ],
  "timeTaken": 106,
  "metaData": {
    "groupbyColumnList": []
  }
}

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