Query
query HeatmapMetric($name: String!) {
heatmapMetric(name: $name) {
days {
percentage
total
threadIds
messageCount
}
}
}Variables
{
"name": "string"
}Response
{
"data": {
"heatmapMetric": {
"days": [
[
{
"percentage": 1.5,
"total": 1,
"threadIds": [
"string"
],
"messageCount": 1
}
]
]
}
}
}Queries
heatmapMetric
Fetch a named heatmap metric for the workspace, distributing activity across a 7-day × 24-hour
grid (Monday–Sunday, hour 0–23 UTC). Each cell reports the thread count, its share of total
volume as a percentage, and the list of thread IDs. Use this to identify peak support hours
during a date range. Requires metrics:read.
QUERY
heatmapMetric(name: String!, options: HeatmapMetricOptionsInput): HeatmapMetricArguments
name
String!
required
options
Returns
days
[[HeatmapHour!]!]!
7 elements (Monday=0 … Sunday=6), each containing 24 hourly buckets (hour 0–23 UTC).
Query
query HeatmapMetric($name: String!) {
heatmapMetric(name: $name) {
days {
percentage
total
threadIds
messageCount
}
}
}Variables
{
"name": "string"
}Response
{
"data": {
"heatmapMetric": {
"days": [
[
{
"percentage": 1.5,
"total": 1,
"threadIds": [
"string"
],
"messageCount": 1
}
]
]
}
}
}Was this page helpful?