Returns analytics for a range of Lookup records specified by a time frame associated with the owner account. The response will contain an object which is comprised of total values and a collection of detail values. Each report contains information for a specific 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 |
|---|---|
| totals | The totals of this report. |
| totals.timeGrouping | The grouping used in this report. |
| totals.totalCount | The total count. |
| totals.totalPrice | The total price. |
| totals.totalQueued | The total queued. |
| totals.totalActive | The total active. |
| totals.totalFailed | The total failed. |
| totals.totalUnknown | The total unknown. |
| totals.totalAbsent | The total absent. |
| details | The details of this report. |
| details.startDateTime | The price for the HLR lookup records of this report. |
| details.price | The amount of the queued messages. |
| details.count | The count for the HLR lookup records of this report. |
| details.activeCount | The count of the active HLR lookup records. |
| details.failedCount | The count of the failed HLR lookup records. |
| details.queuedCount | The count of the queued HLR lookup records. |
| details.absentCount | The count of the absent HLR lookup records. |
| details.unknownCount | The count of the unknown HLR lookup records. |
ERROR CODES
| STATUS | CODE | DESCRIPTION |
|---|---|---|
| 400 | 400007001 | The startDate must precede the endDate and the time range must not exceed five years. |
| 403 | 400001009 | User is not authenticated. |
| 404 | 400001001 | Account not found |