| POST | /v4/report/links |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reports | body | IEnumerable<ReportRequest> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Items | form | IEnumerable<string> | No | |
| GroupBy | form | IEnumerable<GroupBy> | No | |
| Attribute | form | string | No | |
| Type | form | ReportType | No | |
| FromStartUtcInclusive | form | DateTime | No | |
| FromEndUtcInclusive | form | DateTime | No | |
| Retailers | form | IEnumerable<string> | No |
| Default | |
| Retailer | |
| Date |
| ShortUrl | |
| Group | |
| User |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reports | form | IEnumerable<Report> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | List<ReportData> | No | |
| ExecutionTimeMs | form | long | No | |
| TotalItems | form | long | No | |
| Errors | form | List<Error> | No | |
| Request | form | ReportRequest | No | |
| TotalClicks | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Item | form | Item | No | |
| TotalClicks | form | ulong | No | |
| ActualClicks | form | ulong | No | |
| JunkClicks | form | ulong | No | |
| SpiderClicks | form | ulong | No | |
| DateUtc | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| DisplayName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v4/report/links HTTP/1.1
Host: reporting-api-zane.dev.platform.georiot.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}