Conversation traffic heatmap (CSV)
Conversations started per hour of the day, one column per date in the period — the data behind the traffic heatmap. Served as a CSV download. The first line names the timezone the rows are bucketed in.
since and until are Unix epoch seconds sent as strings, and both are required — omitting either returns a 500 rather than a validation error, because the report template parses them unconditionally.
Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the account
Query Parameters
Start of the reporting period, as Unix epoch seconds. Required.
"1787369963"
End of the reporting period, as Unix epoch seconds. Required.
"1789961963"
Hours offset from UTC used to bucket the rows. Required on this endpoint — without it the request returns a 500.
0
Measure the time metrics against the inbox's configured business hours instead of wall-clock time.
Response
CSV file
CSV text. The first line names the reporting period, then a blank line, then the header row and one row per record.