Analytics
Query API
Query interaction data directly with metrics, dimensions, and time-based aggregations.
The analytics query API lets you run ad-hoc queries against your interaction data without creating widgets.
Basic query
POST /api/analytics/query
{
"measures": ["count"],
"dimensions": ["resourceType", "action"],
"timeRange": {
"type": "relative",
"value": "7d"
}
}With filters
POST /api/analytics/query
{
"measures": ["count"],
"dimensions": ["resourceType"],
"filters": [
{
"member": "interactions.action",
"operator": "equals",
"values": ["CREATE"]
},
{
"member": "interactions.createdDate",
"operator": "inDateRange",
"values": ["2024-01-01", "2024-12-31"]
}
]
}Time dimensions
Add time-based grouping for trend analysis:
POST /api/analytics/query
{
"measures": ["count"],
"dimensions": ["action"],
"timeDimensions": [
{
"dimension": "interactions.createdDate",
"granularity": "day"
}
]
}Granularity options
| Value | Description |
|---|---|
hour | Group by hour |
day | Group by day |
week | Group by week |
month | Group by month |
Filter operators
| Operator | Description |
|---|---|
equals | Exact match |
notEquals | Not equal |
contains | String contains |
inDateRange | Between two dates |
gt | Greater than |
lt | Less than |