<Intro>

<EndpointHeader />

<Description>

Returns the number of messages your numbers received, one row per hour.

Rows are bucketed by the time the carrier received the message. Hours with no messages are still included, with a count of zero, so a chart has no gaps.

A row carries a count and nothing else. A received message has one state, so there is no lifecycle to break down and no delivery latency to report; the send statistics endpoints cover those for messages you send.

The maximum window is 720 hours; a longer range returns 422. Set `timezone` to bucket rows by your local hour instead of UTC.

</Description>

</Intro>

<Parameters in="query">

<Parameter name="from" type="string">

<Description>

Start of the window (inclusive), an RFC 3339 instant truncated to the hour. Defaults to 7 days (168 hours) before `to` when omitted.

</Description>

</Parameter>

<Parameter name="to" type="string">

<Description>

End of the window (inclusive), an RFC 3339 instant truncated to the hour. Defaults to the current hour when omitted. Window may not exceed 720 hours. A numeric UTC offset (for example `+05:45`) is rejected when `timezone` is set; pass a calendar day or a `Z` instant instead.

</Description>

</Parameter>

<Parameter name="timezone" type="string">

<Description>

IANA timezone identifier (for example `Asia/Kathmandu`) to report in; defaults to UTC. Day and hour boundaries and the default window when `from` and `to` are omitted both follow it, so a calendar-day `from` or `to` names a local day. A `from` or `to` carrying its own UTC offset is rejected while this is set: pass a calendar day or a `Z` instant.

</Description>

</Parameter>

</Parameters>

<Payload kind="response">

<Field name="period" type="object" required>

<Description>

The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.

</Description>

<FieldChildren kind="response">

<Field name="from" type="string" prefix="period." required>

<Description>

Inclusive start of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant rounded to the hour on the hour grain.

</Description>

</Field>

<Field name="to" type="string" prefix="period." required>

<Description>

Inclusive end of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant rounded to the hour on the hour grain.

</Description>

</Field>

<Field name="grain" type="string" prefix="period." required>

<Description>

The bucket grain of the series, either `day` or `hour`.

</Description>

<Description>

Possible values: `day`, `hour`

</Description>

</Field>

<Field name="data_as_of" type="nullable string" prefix="period.">

<Description>

The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response is near-real-time but not live; use this field to label data freshness rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="data" type="array of object" required>

<Description>

One row per bucket (day or hour, per the grain) in the period, in chronological order. Buckets with no activity are included with a count of zero, so the series charts continuously without client-side gap handling.

</Description>

<FieldChildren kind="response">

<Field name="bucket" type="string" prefix="data." required>

<Description>

Start of the bucket this row covers, as a calendar day (YYYY-MM-DD) for the daily series or an hour boundary (RFC 3339) for the hourly one.

</Description>

</Field>

<Field name="received" type="integer" prefix="data." required>

<Description>

Distinct messages received in this bucket, counted by the time the carrier received them.

</Description>

</Field>

</FieldChildren>

</Field>

</Payload>