| Standard Carrier Alpha Code® (SCAC®) |
The UsageReport method retrieves the usage data for the specified period.
See the following for more information:
- Method Definition
- UsageReport Method Parameter Name, Description, and Data Type
- Method Result
- UsageReport Method JSON Result
- UsageReport Method Result Definition
Method Definition
Http Method: POST
Authorization header: Bearer JWT
URL: https://scacapi.scaccode.com/Account/UsageReport
UsageReport Method Parameter Name, Description, and Data Type
| Parameter Name | Description | Data Type |
| startDate | Start Date for the time period. |
|
| endDate | End Date for the time period. |
|
Method Result
UsageReport Method JSON Result
| Result Status | Result JSON String |
| Success |
{ "days": [ { "date": "2024-09-11", "count": 3 }, { "date": "2024-09-12", "count": 5 } ], "queryTotal": 9, "success": true, "errorMessage ": null } |
| Failure |
{ "success": false, "errorMessage": “There was a problem with your request.” } |
UsageReport Method Result Definition
| JSON Properties | Description | Data Type |
| Days | Array of days. |
|
| Date | Transaction Date. |
|
| Count | Total number of requests per day. |
|
| ErrorMessage | Error description. |
|