| POST | /v4/report/links |
|---|
namespace Geniuslink.Reporting.Contracts.V1.DTOs
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type Item() =
[<DataMember(Name="id")>]
member val Id:String = null with get,set
[<DataMember(Name="displayName")>]
member val DisplayName:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ReportData() =
[<DataMember(Name="id")>]
member val Id:String = null with get,set
[<DataMember(Name="item")>]
member val Item:Item = null with get,set
[<DataMember(Name="totalClicks")>]
member val TotalClicks:UInt64 = new UInt64() with get,set
[<DataMember(Name="clicks")>]
member val ActualClicks:UInt64 = new UInt64() with get,set
[<DataMember(Name="junkClicks")>]
member val JunkClicks:UInt64 = new UInt64() with get,set
[<DataMember(Name="spiderClicks")>]
member val SpiderClicks:UInt64 = new UInt64() with get,set
[<DataMember(Name="dateUtc")>]
member val DateUtc:DateTime = new DateTime() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Error() =
[<DataMember(Name="code")>]
member val Code:String = null with get,set
type GroupBy =
| Default = 0
| Retailer = 1
| Date = 2
type ReportType =
| ShortUrl = 0
| Group = 1
| User = 2
[<DataContract>]
[<AllowNullLiteral>]
type ReportRequest() =
[<DataMember(Name="items")>]
member val Items:IEnumerable<String> = null with get,set
[<DataMember(Name="groupBy")>]
member val GroupBy:IEnumerable<GroupBy> = null with get,set
[<DataMember(Name="attribute")>]
member val Attribute:String = null with get,set
[<DataMember(Name="type")>]
member val Type:ReportType = new ReportType() with get,set
[<DataMember(Name="fromStartUtcInclusive")>]
member val FromStartUtcInclusive:DateTime = new DateTime() with get,set
[<DataMember(Name="fromEndUtcInclusive")>]
member val FromEndUtcInclusive:DateTime = new DateTime() with get,set
[<DataMember(Name="retailers")>]
member val Retailers:IEnumerable<String> = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Report() =
[<DataMember(Name="data")>]
member val Data:ResizeArray<ReportData> = null with get,set
[<DataMember(Name="executionTimeMs")>]
member val ExecutionTimeMs:Int64 = new Int64() with get,set
[<DataMember(Name="totalItems")>]
member val TotalItems:Int64 = new Int64() with get,set
[<DataMember(Name="errors")>]
member val Errors:ResizeArray<Error> = null with get,set
[<DataMember(Name="request")>]
member val Request:ReportRequest = null with get,set
[<DataMember(Name="totalClicks")>]
member val TotalClicks:Int64 = new Int64() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type PostLinkReportResponse() =
[<DataMember(Name="reports")>]
member val Reports:IEnumerable<Report> = null with get,set
[<DataMember(Name="responseStatus")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type PostLinkReportRequest() =
[<DataMember(Name="reports")>]
member val Reports:IEnumerable<ReportRequest> = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}