Get message metrics
Returns your texting over a window (the last 7 days by default, starting at most a year back): texts sent and received, how the sent ones ended up (delivered, left the phone with no delivery report, unconfirmed, failed, still queued) and the delivery rate, how long they took to send and to be delivered, why they failed, your conversations and how many of the ones you texted wrote back within a day, and each phone's share with its busiest 30 minutes, to compare with the send_limit the response carries. The points chart it by the hour or the day (granularity) in time_zone; hour buckets need a window of 7 days or less. Scope it to one phone with phone_id or one conversation with conversation_id. A text counts at the time the platform stored it when sent, and when the phone received it when received.
Request
- Base URLhttps://api.axilio.ai/api/v1
- AuthAPI key in header X-Axilio-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Start of the window (RFC 3339). Defaults to 7 days before period_end_at, and may be at most a year before now.
End of the window (RFC 3339). Defaults to now, and a later time is read as now.
Bucket size: hour or day. hour is allowed for windows of 7 days or less.
IANA time zone the buckets follow, such as America/Los_Angeles: a day starts at local midnight and an hour on the local hour. An unknown name is an error.
Only this phone's texts. A phone your organization doesn't rent is not found.
Only this conversation's texts, and only its phone. Another organization's conversation is not found. When phone_id is also given, it is ignored: the conversation names the phone.
Response
OK