Execute analytics query
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": [
{
"field": "<string>"
}
],
"timeRange": {
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
}
'import requests
url = "https://platform.kodexa.ai/api/analytics/query"
payload = {
"dataset": "<string>",
"organizationId": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {},
"values": [{}]
}
],
"groupBy": ["<string>"],
"limit": 123,
"metrics": ["<string>"],
"offset": 123,
"projectId": "<string>",
"sort": [{ "field": "<string>" }],
"timeRange": {
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataset: '<string>',
organizationId: '<string>',
filters: [{field: '<string>', operator: '<string>', value: {}, values: [{}]}],
groupBy: ['<string>'],
limit: 123,
metrics: ['<string>'],
offset: 123,
projectId: '<string>',
sort: [{field: '<string>'}],
timeRange: {field: '<string>', from: '<string>', to: '<string>'}
})
};
fetch('https://platform.kodexa.ai/api/analytics/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/analytics/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dataset' => '<string>',
'organizationId' => '<string>',
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => [
],
'values' => [
[
]
]
]
],
'groupBy' => [
'<string>'
],
'limit' => 123,
'metrics' => [
'<string>'
],
'offset' => 123,
'projectId' => '<string>',
'sort' => [
[
'field' => '<string>'
]
],
'timeRange' => [
'field' => '<string>',
'from' => '<string>',
'to' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/analytics/query"
payload := strings.NewReader("{\n \"dataset\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {},\n \"values\": [\n {}\n ]\n }\n ],\n \"groupBy\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"metrics\": [\n \"<string>\"\n ],\n \"offset\": 123,\n \"projectId\": \"<string>\",\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"timeRange\": {\n \"field\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/analytics/query")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataset\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {},\n \"values\": [\n {}\n ]\n }\n ],\n \"groupBy\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"metrics\": [\n \"<string>\"\n ],\n \"offset\": 123,\n \"projectId\": \"<string>\",\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"timeRange\": {\n \"field\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/analytics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {},\n \"values\": [\n {}\n ]\n }\n ],\n \"groupBy\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"metrics\": [\n \"<string>\"\n ],\n \"offset\": 123,\n \"projectId\": \"<string>\",\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"timeRange\": {\n \"field\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"columns": [
"<string>"
],
"dataset": "<string>",
"rowCount": 123,
"rows": [
{}
]
}Analytics
Execute analytics query
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.
POST
/
api
/
analytics
/
query
Execute analytics query
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": [
{
"field": "<string>"
}
],
"timeRange": {
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
}
'import requests
url = "https://platform.kodexa.ai/api/analytics/query"
payload = {
"dataset": "<string>",
"organizationId": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {},
"values": [{}]
}
],
"groupBy": ["<string>"],
"limit": 123,
"metrics": ["<string>"],
"offset": 123,
"projectId": "<string>",
"sort": [{ "field": "<string>" }],
"timeRange": {
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataset: '<string>',
organizationId: '<string>',
filters: [{field: '<string>', operator: '<string>', value: {}, values: [{}]}],
groupBy: ['<string>'],
limit: 123,
metrics: ['<string>'],
offset: 123,
projectId: '<string>',
sort: [{field: '<string>'}],
timeRange: {field: '<string>', from: '<string>', to: '<string>'}
})
};
fetch('https://platform.kodexa.ai/api/analytics/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/analytics/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dataset' => '<string>',
'organizationId' => '<string>',
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => [
],
'values' => [
[
]
]
]
],
'groupBy' => [
'<string>'
],
'limit' => 123,
'metrics' => [
'<string>'
],
'offset' => 123,
'projectId' => '<string>',
'sort' => [
[
'field' => '<string>'
]
],
'timeRange' => [
'field' => '<string>',
'from' => '<string>',
'to' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/analytics/query"
payload := strings.NewReader("{\n \"dataset\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {},\n \"values\": [\n {}\n ]\n }\n ],\n \"groupBy\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"metrics\": [\n \"<string>\"\n ],\n \"offset\": 123,\n \"projectId\": \"<string>\",\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"timeRange\": {\n \"field\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/analytics/query")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataset\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {},\n \"values\": [\n {}\n ]\n }\n ],\n \"groupBy\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"metrics\": [\n \"<string>\"\n ],\n \"offset\": 123,\n \"projectId\": \"<string>\",\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"timeRange\": {\n \"field\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/analytics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {},\n \"values\": [\n {}\n ]\n }\n ],\n \"groupBy\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"metrics\": [\n \"<string>\"\n ],\n \"offset\": 123,\n \"projectId\": \"<string>\",\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"timeRange\": {\n \"field\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"columns": [
"<string>"
],
"dataset": "<string>",
"rowCount": 123,
"rows": [
{}
]
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Request body for dataset-driven analytics queries.
Dataset key returned by /api/analytics/datasets.
Organization scope for the query.
Show child attributes
Show child attributes
Optional project scope when supported by the dataset.
Show child attributes
Show child attributes
Time bounds for analytics filtering.
Show child attributes
Show child attributes
⌘I
