Query Analytics
curl --request POST \
--url https://api.peachdeskai.com/api/v1/organizations/reports/analytics/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"metric": "<string>",
"breakdown": "<string>",
"column_breakdown": "<string>",
"granularity": "<string>",
"workflow_id": 123,
"call_type": "<string>",
"state": "<string>",
"campaign_id": 123,
"dashboard": "call",
"offset": 0,
"page_size": 50,
"sort_by": "<string>",
"sort_dir": "desc"
}
'import requests
url = "https://api.peachdeskai.com/api/v1/organizations/reports/analytics/query"
payload = {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"metric": "<string>",
"breakdown": "<string>",
"column_breakdown": "<string>",
"granularity": "<string>",
"workflow_id": 123,
"call_type": "<string>",
"state": "<string>",
"campaign_id": 123,
"dashboard": "call",
"offset": 0,
"page_size": 50,
"sort_by": "<string>",
"sort_dir": "desc"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start: '2023-11-07T05:31:56Z',
end: '2023-11-07T05:31:56Z',
metric: '<string>',
breakdown: '<string>',
column_breakdown: '<string>',
granularity: '<string>',
workflow_id: 123,
call_type: '<string>',
state: '<string>',
campaign_id: 123,
dashboard: 'call',
offset: 0,
page_size: 50,
sort_by: '<string>',
sort_dir: 'desc'
})
};
fetch('https://api.peachdeskai.com/api/v1/organizations/reports/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://api.peachdeskai.com/api/v1/organizations/reports/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([
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z',
'metric' => '<string>',
'breakdown' => '<string>',
'column_breakdown' => '<string>',
'granularity' => '<string>',
'workflow_id' => 123,
'call_type' => '<string>',
'state' => '<string>',
'campaign_id' => 123,
'dashboard' => 'call',
'offset' => 0,
'page_size' => 50,
'sort_by' => '<string>',
'sort_dir' => 'desc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.peachdeskai.com/api/v1/organizations/reports/analytics/query"
payload := strings.NewReader("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metric\": \"<string>\",\n \"breakdown\": \"<string>\",\n \"column_breakdown\": \"<string>\",\n \"granularity\": \"<string>\",\n \"workflow_id\": 123,\n \"call_type\": \"<string>\",\n \"state\": \"<string>\",\n \"campaign_id\": 123,\n \"dashboard\": \"call\",\n \"offset\": 0,\n \"page_size\": 50,\n \"sort_by\": \"<string>\",\n \"sort_dir\": \"desc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.peachdeskai.com/api/v1/organizations/reports/analytics/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metric\": \"<string>\",\n \"breakdown\": \"<string>\",\n \"column_breakdown\": \"<string>\",\n \"granularity\": \"<string>\",\n \"workflow_id\": 123,\n \"call_type\": \"<string>\",\n \"state\": \"<string>\",\n \"campaign_id\": 123,\n \"dashboard\": \"call\",\n \"offset\": 0,\n \"page_size\": 50,\n \"sort_by\": \"<string>\",\n \"sort_dir\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peachdeskai.com/api/v1/organizations/reports/analytics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metric\": \"<string>\",\n \"breakdown\": \"<string>\",\n \"column_breakdown\": \"<string>\",\n \"granularity\": \"<string>\",\n \"workflow_id\": 123,\n \"call_type\": \"<string>\",\n \"state\": \"<string>\",\n \"campaign_id\": 123,\n \"dashboard\": \"call\",\n \"offset\": 0,\n \"page_size\": 50,\n \"sort_by\": \"<string>\",\n \"sort_dir\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"total": 123,
"series": [
{
"key": "<string>",
"value": 123,
"group": "<string>"
}
],
"matrix": {
"columns": [
"<string>"
],
"rows": [
"<string>"
],
"cells": [
{
"row": "<string>",
"column": "<string>",
"value": 123
}
],
"rowTotals": {},
"columnTotals": {},
"grandTotal": 123,
"totalRows": 123,
"offset": 123,
"pageSize": 123
},
"page": {
"totalRows": 123,
"offset": 123,
"pageSize": 123
},
"truncated": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}main
Query Analytics
Run a single analytics query (one chart) over the orgтАЩs workflow runs.
POST
/
api
/
v1
/
organizations
/
reports
/
analytics
/
query
Query Analytics
curl --request POST \
--url https://api.peachdeskai.com/api/v1/organizations/reports/analytics/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"metric": "<string>",
"breakdown": "<string>",
"column_breakdown": "<string>",
"granularity": "<string>",
"workflow_id": 123,
"call_type": "<string>",
"state": "<string>",
"campaign_id": 123,
"dashboard": "call",
"offset": 0,
"page_size": 50,
"sort_by": "<string>",
"sort_dir": "desc"
}
'import requests
url = "https://api.peachdeskai.com/api/v1/organizations/reports/analytics/query"
payload = {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"metric": "<string>",
"breakdown": "<string>",
"column_breakdown": "<string>",
"granularity": "<string>",
"workflow_id": 123,
"call_type": "<string>",
"state": "<string>",
"campaign_id": 123,
"dashboard": "call",
"offset": 0,
"page_size": 50,
"sort_by": "<string>",
"sort_dir": "desc"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start: '2023-11-07T05:31:56Z',
end: '2023-11-07T05:31:56Z',
metric: '<string>',
breakdown: '<string>',
column_breakdown: '<string>',
granularity: '<string>',
workflow_id: 123,
call_type: '<string>',
state: '<string>',
campaign_id: 123,
dashboard: 'call',
offset: 0,
page_size: 50,
sort_by: '<string>',
sort_dir: 'desc'
})
};
fetch('https://api.peachdeskai.com/api/v1/organizations/reports/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://api.peachdeskai.com/api/v1/organizations/reports/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([
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z',
'metric' => '<string>',
'breakdown' => '<string>',
'column_breakdown' => '<string>',
'granularity' => '<string>',
'workflow_id' => 123,
'call_type' => '<string>',
'state' => '<string>',
'campaign_id' => 123,
'dashboard' => 'call',
'offset' => 0,
'page_size' => 50,
'sort_by' => '<string>',
'sort_dir' => 'desc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.peachdeskai.com/api/v1/organizations/reports/analytics/query"
payload := strings.NewReader("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metric\": \"<string>\",\n \"breakdown\": \"<string>\",\n \"column_breakdown\": \"<string>\",\n \"granularity\": \"<string>\",\n \"workflow_id\": 123,\n \"call_type\": \"<string>\",\n \"state\": \"<string>\",\n \"campaign_id\": 123,\n \"dashboard\": \"call\",\n \"offset\": 0,\n \"page_size\": 50,\n \"sort_by\": \"<string>\",\n \"sort_dir\": \"desc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.peachdeskai.com/api/v1/organizations/reports/analytics/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metric\": \"<string>\",\n \"breakdown\": \"<string>\",\n \"column_breakdown\": \"<string>\",\n \"granularity\": \"<string>\",\n \"workflow_id\": 123,\n \"call_type\": \"<string>\",\n \"state\": \"<string>\",\n \"campaign_id\": 123,\n \"dashboard\": \"call\",\n \"offset\": 0,\n \"page_size\": 50,\n \"sort_by\": \"<string>\",\n \"sort_dir\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peachdeskai.com/api/v1/organizations/reports/analytics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"metric\": \"<string>\",\n \"breakdown\": \"<string>\",\n \"column_breakdown\": \"<string>\",\n \"granularity\": \"<string>\",\n \"workflow_id\": 123,\n \"call_type\": \"<string>\",\n \"state\": \"<string>\",\n \"campaign_id\": 123,\n \"dashboard\": \"call\",\n \"offset\": 0,\n \"page_size\": 50,\n \"sort_by\": \"<string>\",\n \"sort_dir\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"total": 123,
"series": [
{
"key": "<string>",
"value": 123,
"group": "<string>"
}
],
"matrix": {
"columns": [
"<string>"
],
"rows": [
"<string>"
],
"cells": [
{
"row": "<string>",
"column": "<string>",
"value": 123
}
],
"rowTotals": {},
"columnTotals": {},
"grandTotal": 123,
"totalRows": 123,
"offset": 123,
"pageSize": 123
},
"page": {
"totalRows": 123,
"offset": 123,
"pageSize": 123
},
"truncated": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
SessionAuthApiKeyAuth
Interactive user session: the login JWT, sent as Authorization: Bearer <token>.
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
One page of a crosstab.
Serialized in the camelCase the matrix renderer already consumes. Every
total is computed server-side over the FULL filtered set тАФ the client must
never derive one by summing cells, which holds one page of a possibly
non-additive metric. On the in-memory path that set is the fetch, which can
be clipped; the response's truncated flag is what says so.
Show child attributes
Show child attributes
Paging envelope for a bounded single-dimension breakdown.
Show child attributes
Show child attributes

