Get time-series chart data for histories
curl --request POST \
--url https://pria.praxislxp.com/api/admin/histories/charts/timeline \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"granularity": "month",
"range": -3,
"dimension": "count",
"institution": "65cfebc32f5e1b37d4e52329",
"account": "<string>",
"aggregate": false,
"topsearch": 5
}
'import requests
url = "https://pria.praxislxp.com/api/admin/histories/charts/timeline"
payload = {
"granularity": "month",
"range": -3,
"dimension": "count",
"institution": "65cfebc32f5e1b37d4e52329",
"account": "<string>",
"aggregate": False,
"topsearch": 5
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
granularity: 'month',
range: -3,
dimension: 'count',
institution: '65cfebc32f5e1b37d4e52329',
account: '<string>',
aggregate: false,
topsearch: 5
})
};
fetch('https://pria.praxislxp.com/api/admin/histories/charts/timeline', 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://pria.praxislxp.com/api/admin/histories/charts/timeline",
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([
'granularity' => 'month',
'range' => -3,
'dimension' => 'count',
'institution' => '65cfebc32f5e1b37d4e52329',
'account' => '<string>',
'aggregate' => false,
'topsearch' => 5
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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://pria.praxislxp.com/api/admin/histories/charts/timeline"
payload := strings.NewReader("{\n \"granularity\": \"month\",\n \"range\": -3,\n \"dimension\": \"count\",\n \"institution\": \"65cfebc32f5e1b37d4e52329\",\n \"account\": \"<string>\",\n \"aggregate\": false,\n \"topsearch\": 5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<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://pria.praxislxp.com/api/admin/histories/charts/timeline")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"granularity\": \"month\",\n \"range\": -3,\n \"dimension\": \"count\",\n \"institution\": \"65cfebc32f5e1b37d4e52329\",\n \"account\": \"<string>\",\n \"aggregate\": false,\n \"topsearch\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/histories/charts/timeline")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"granularity\": \"month\",\n \"range\": -3,\n \"dimension\": \"count\",\n \"institution\": \"65cfebc32f5e1b37d4e52329\",\n \"account\": \"<string>\",\n \"aggregate\": false,\n \"topsearch\": 5\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"_id": {
"granularity": "2023-11-07T05:31:56Z",
"institution": "<string>"
},
"dimension": 123
}
]
}Admin Histories
Get time-series chart data for histories
Optimized endpoint for time-series charts (bar, line, area, heatmap, scatter). Supports count, credits, usage, cached, and price dimensions. Uses a 2-step top-N query to avoid fetching data for all institutions.
POST
/
api
/
admin
/
histories
/
charts
/
timeline
Get time-series chart data for histories
curl --request POST \
--url https://pria.praxislxp.com/api/admin/histories/charts/timeline \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"granularity": "month",
"range": -3,
"dimension": "count",
"institution": "65cfebc32f5e1b37d4e52329",
"account": "<string>",
"aggregate": false,
"topsearch": 5
}
'import requests
url = "https://pria.praxislxp.com/api/admin/histories/charts/timeline"
payload = {
"granularity": "month",
"range": -3,
"dimension": "count",
"institution": "65cfebc32f5e1b37d4e52329",
"account": "<string>",
"aggregate": False,
"topsearch": 5
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
granularity: 'month',
range: -3,
dimension: 'count',
institution: '65cfebc32f5e1b37d4e52329',
account: '<string>',
aggregate: false,
topsearch: 5
})
};
fetch('https://pria.praxislxp.com/api/admin/histories/charts/timeline', 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://pria.praxislxp.com/api/admin/histories/charts/timeline",
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([
'granularity' => 'month',
'range' => -3,
'dimension' => 'count',
'institution' => '65cfebc32f5e1b37d4e52329',
'account' => '<string>',
'aggregate' => false,
'topsearch' => 5
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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://pria.praxislxp.com/api/admin/histories/charts/timeline"
payload := strings.NewReader("{\n \"granularity\": \"month\",\n \"range\": -3,\n \"dimension\": \"count\",\n \"institution\": \"65cfebc32f5e1b37d4e52329\",\n \"account\": \"<string>\",\n \"aggregate\": false,\n \"topsearch\": 5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<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://pria.praxislxp.com/api/admin/histories/charts/timeline")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"granularity\": \"month\",\n \"range\": -3,\n \"dimension\": \"count\",\n \"institution\": \"65cfebc32f5e1b37d4e52329\",\n \"account\": \"<string>\",\n \"aggregate\": false,\n \"topsearch\": 5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/histories/charts/timeline")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"granularity\": \"month\",\n \"range\": -3,\n \"dimension\": \"count\",\n \"institution\": \"65cfebc32f5e1b37d4e52329\",\n \"account\": \"<string>\",\n \"aggregate\": false,\n \"topsearch\": 5\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"_id": {
"granularity": "2023-11-07T05:31:56Z",
"institution": "<string>"
},
"dimension": 123
}
]
}Authorizations
JWT token passed in x-access-token header
Body
application/json
Time granularity for bucketing
Available options:
day, week, month, hour Example:
"month"
Time range (negative values for past periods)
Example:
-3
Metric to aggregate
Available options:
count, credits, usage, cached, price Example:
"count"
Institution ID (optional, filters by institution)
Example:
"65cfebc32f5e1b37d4e52329"
Account ID (optional, filters by account's institutions)
When true, aggregates across all institutions
Example:
false
Number of top institutions to return (default 5, -1 for all)
Example:
5
Was this page helpful?
⌘I