Returns analytics for a range of Number Validator 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 |
|---|---|
| details | Contains the details analytics for a range of Number Validator records associated with the account id |
| details.count | The count for the Number Validator records of this report |
| details.invalidCount | The count of the invalid Number Validator records |
| details.price | The price for the Number Validator records of this report |
| details.startDateTime | The starting date and time from which this report was generated |
| details.validCount | The count of the valid Number Validator records |
| totals | Contains the totals analytics for a range of Number Validator records associated with the account id |
| totals.timeGrouping | The grouping used in this report |
| totals.totalCount | The total count |
| totals.totalInvalid | The total invalid |
| totals.totalPrice | The total price |
| totals.totalValid | The total valid |
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 |