Volume and response-time trends for an inbox
A gap-free time series for one inbox, rolled up server-side by day, week, month or quarter. Both dateFrom and dateTo are required (max 400 days); dateTo is exclusive. Periods with no activity are returned with zero volume rather than omitted, so the series can be charted directly.
All bucketing is UTC. Weeks start Monday (ISO) and are keyed by that Monday's date, so week keys sort alongside day keys.
Two bucketing bases, deliberately: volume counts messages sent or received during the period, while threadCount and the response/rate figures describe threads whose last activity fell in the period. Response times carry no per-message timestamps, so they can't be attributed to a single day of a long-running thread. Do not divide volume by threadCount.
Averages are combined from underlying sums and counts, so a quiet day never carries the same weight as a busy one. responseCount is the number of replies behind avgResponseHrs.
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
External channel meta ID (meta.id) of the inbox.
Query parameters
Exclusive. Range must not exceed 400 days.
Response
Gap-free trend series, oldest period first.
Changes
No recorded changes to this operation across all 1 revision of this API.