Skip to main content
POST
/
api
/
admin
/
histories
/
charts
/
heatmap
Get peak usage heatmap for conversations
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/histories/charts/heatmap \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institution": "<string>",
  "account": "<string>",
  "daterange": [
    "2023-12-25"
  ]
}
'
import requests

url = "https://pria.praxislxp.com/api/admin/histories/charts/heatmap"

payload = {
    "institution": "<string>",
    "account": "<string>",
    "daterange": ["2023-12-25"]
}
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({institution: '<string>', account: '<string>', daterange: ['2023-12-25']})
};

fetch('https://pria.praxislxp.com/api/admin/histories/charts/heatmap', 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/heatmap",
  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([
    'institution' => '<string>',
    'account' => '<string>',
    'daterange' => [
        '2023-12-25'
    ]
  ]),
  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/heatmap"

	payload := strings.NewReader("{\n  \"institution\": \"<string>\",\n  \"account\": \"<string>\",\n  \"daterange\": [\n    \"2023-12-25\"\n  ]\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/heatmap")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"institution\": \"<string>\",\n  \"account\": \"<string>\",\n  \"daterange\": [\n    \"2023-12-25\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/admin/histories/charts/heatmap")

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  \"institution\": \"<string>\",\n  \"account\": \"<string>\",\n  \"daterange\": [\n    \"2023-12-25\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": [
    {
      "day": 123,
      "hour": 123,
      "count": 123
    }
  ]
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
institution
string

Space-separated institution IDs to filter

account
string

Space-separated account IDs to filter

daterange
string<date>[]

[startDate, endDate] — defaults to last month if omitted

Required array length: 2 elements

Response

Successfully retrieved heatmap data

success
boolean
data
object[]