Returns analytics for a range of messages specified by a time frame associated with the owner account. The response will contain an array of reports. Each report contains information for a specific country, operator, campaign and date time. The startDateTime of a report combined with the timeGrouping represent the time period that this report corresponds to. The time grouping is calculated depending on the supplied starting and ending date time. The possible results is showed bellow:
interval Hour: Fetch results in hourly intervals. True if endDate startDate <= 24h
interval Day: Fetch results in daily intervals. True if 24h < endDate startDate <= month
interval Month: Fetch results in monthly intervals. True if month < endDate - startDate <= year
interval Year: Fetch results in yearly intervals. True if Year < endDate - startDate <= 5 years
RESPONSE PARAMETERS
| KEY | DESCRIPTION |
|---|---|
| country | The country’s code in ISO 31661 alpha2 format. |
| operator | The operator’s name. |
| mcc | The mobile country code. |
| mnc | The mobile network code. |
| startDateTime | The date and time of the first SMS of this report. |
| timeGrouping | The time interval that the reports are grouped by. |
| smsCampaignId | The ID of the campaign that the SMS belongs to. |
| count | The total messages count. |
| deliveredCount | The amount of the delivered messages. |
| failedCount | The amount of the failed messages. |
| unsentCount | The amount of the unsent messages. |
| queuedCount | The amount of the queued messages. |
| sentCount | The amount of the sent messages. |
| undeliveredCount | The amount of the messages with status undelivered. |
| price | The total price of this report. |
ERROR CODES
| STATUS | CODE | DESCRIPTION |
|---|---|---|
| 400 | 400007001 | The startDate must precede the endDate and the time range must not exceed five years. |