| GET | /v1/links/report |
|---|
namespace Booklinker.API.ServiceModel.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 ClickReport() =
[<DataMember(Name="code")>]
member val Code:String = null with get,set
[<DataMember(Name="reports")>]
member val Reports:Dictionary<String, Report> = null with get,set
[<DataMember(Name="totalClicks")>]
member val TotalClicks:UInt64 = new UInt64() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetLinkReportResponse() =
[<DataMember(Name="reports")>]
member val Report:ClickReport = null with get,set
[<DataMember(Name="responseStatus")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetLinkReportRequest() =
[<DataMember(Name="baseCode")>]
member val BaseCode:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Report() =
inherit Report()
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/links/report HTTP/1.1 Host: api.booklinker.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
reports:
{
code: String,
reports:
{
String:
{
data:
[
{
id: String,
item:
{
id: String,
displayName: String
},
totalClicks: 0,
clicks: 0,
junkClicks: 0,
spiderClicks: 0,
dateUtc: 0001-01-01
}
],
executionTimeMs: 0,
totalItems: 1,
errors:
[
{
}
],
request:
{
attribute: String,
type: ShortUrl,
fromStartUtcInclusive: 0001-01-01,
fromEndUtcInclusive: 0001-01-01
},
totalClicks: 0
}
},
totalClicks: 0
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}