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"
  ]
}
'
{
  "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[]