GET
/
statistics
/
heatmap
cURL
curl --request GET \
  --url https://api.gleap.io/v3/statistics/heatmap \
  --header 'Authorization: Bearer <token>'
"<any>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
chartType
enum<string>
required
  • Type of heatmap data (BUSIEST_HOURS_PER_WEEKDAY, BUSIEST_COMMENTS_PER_WEEKDAY)
Available options:
BUSIEST_HOURS_PER_WEEKDAY,
BUSIEST_COMMENTS_PER_WEEKDAY
​
timezone
string
  • Timezone for date calculations
​
groupInterval
enum<string>
Available options:
day,
month,
year
​
skip
number
​
limit
number
​
groupedBy
string
​
aggsType
string
​
startDate
string
  • Start date for filtering (ISO format)
​
endDate
string
  • End date for filtering (ISO format)
​
createdAt
string
​
updatedAt
string

Response

200 - application/json

Ok

The response is of type any.