| GET | /ApiRequestsPerHour |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateStart | query | string | Yes | Date in format YYYYMMDD |
| DateEnd | query | string | Yes | Date in format YYYYMMDD |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | query | string | No | Starting Record |
| Limit | query | string | No | Number of records to return (PageSize) |
| TotalRecords | query | string | No | Total Number of Records in a Full Reponse (if no paging) |
| ResponseRecords | query | string | No | Total Number of Records in this Reponse (on this page) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseMetadata | form | ResponseMetadata | No | |
| ResponseReport | form | List<TItem> | No | |
| ResponseError | form | AgentivityError | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| HasCache | form | bool | No | |
| HasPaging | form | bool | No | |
| CacheMetadata | form | CacheMetadata | No | |
| PagingMetadata | form | PagingMetadata | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CachedAt | form | DateTime | No | |
| CacheExpiresAt | form | DateTime | No | |
| IsFromCache | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ErrorCode | form | string | No | |
| Message | form | string | No | |
| StatusCode | form | string | No | |
| VerboseMessage | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET //ApiRequestsPerHour HTTP/1.1 Host: api.agentivity.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"RequestDate":"\/Date(-62135596800000-0000)\/","Hour0":0,"Hour1":0,"Hour2":0,"Hour3":0,"Hour4":0,"Hour5":0,"Hour6":0,"Hour7":0,"Hour8":0,"Hour9":0,"Hour10":0,"Hour11":0,"Hour12":0,"Hour13":0,"Hour14":0,"Hour15":0,"Hour16":0,"Hour17":0,"Hour18":0,"Hour19":0,"Hour20":0,"Hour21":0,"Hour22":0,"Hour23":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}