curl --request POST \
--url https://platform.kodexa.ai/api/analytics/query \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"dataset": "<string>",
"organizationId": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {},
"values": [
{}
]
}
],
"groupBy": [
"<string>"
],
"limit": 123,
"metrics": [
"<string>"
],
"offset": 123,
"projectId": "<string>",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"timeRange": {
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
}
'{
"columns": [
"<string>"
],
"dataset": "<string>",
"rowCount": 123,
"rows": [
{}
]
}Runs a server-side dataset query with grouping, metrics, filters, and sorting. The API validates all fields against a fixed dataset catalog and applies FGAC scope checks.
curl --request POST \
--url https://platform.kodexa.ai/api/analytics/query \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"dataset": "<string>",
"organizationId": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {},
"values": [
{}
]
}
],
"groupBy": [
"<string>"
],
"limit": 123,
"metrics": [
"<string>"
],
"offset": 123,
"projectId": "<string>",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"timeRange": {
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
}
'{
"columns": [
"<string>"
],
"dataset": "<string>",
"rowCount": 123,
"rows": [
{}
]
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Request body for dataset-driven analytics queries.
Dataset key returned by /api/analytics/datasets.
Organization scope for the query.
Show child attributes
Optional project scope when supported by the dataset.
Show child attributes
Time bounds for analytics filtering.
Show child attributes