Skip to main content
POST
/
analytics
/
widgets
/
execute-query
Execute Query
curl --request POST \
  --url https://api.decodahealth.com/analytics/widgets/execute-query \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "queryConfig": {
    "table": "<string>",
    "fields": [
      "<string>"
    ],
    "filters": [
      {}
    ],
    "aggregations": {},
    "groupBy": [
      "<string>"
    ],
    "temporalGrouping": {},
    "orderBy": {}
  },
  "tz": "<string>",
  "page": 123,
  "perPage": 123,
  "sortBy": "<string>",
  "sortDirection": "asc",
  "locationId": "<string>",
  "chartType": "<string>",
  "search": "<string>"
}
'
{
  "data": [
    {}
  ],
  "totalCount": 123,
  "executionTimeMs": 123,
  "metadata": {}
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Schema for executing a query.

queryConfig
QueryConfigSchema · object
required

Query builder configuration

tz
string
required

Timezone for date filtering and temporal grouping

page
integer | null
perPage
integer | null
sortBy
string | null
sortDirection
enum<string> | null
Available options:
asc,
desc
locationId
string | null
chartType
string | null

Chart type to optimize query behavior (table, bar, etc.)

search
string | null

Global search term to filter across text fields

Response

Successful Response

Schema for query execution results.

data
Data · object[]
required

Query result data

totalCount
integer
required

Total number of results

executionTimeMs
number
required

Query execution time in milliseconds

metadata
Metadata · object

Field metadata for chart rendering