Booklinker.API

GetLinkReportRequest

The following routes are available for this service:
GET	/v1/links/report

import Foundation
import ServiceStack

// @DataContract
public class GetLinkReportRequest : Codable
{
    // @DataMember(Name="baseCode")
    public var baseCode:String

    required public init(){}
}

// @DataContract
public class GetLinkReportResponse : Codable
{
    // @DataMember(Name="reports")
    public var reports:ClickReport

    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class ClickReport : Codable
{
    // @DataMember(Name="code")
    public var code:String

    // @DataMember(Name="reports")
    public var reports:[String:Report]

    // @DataMember(Name="totalClicks")
    public var totalClicks:UInt64

    required public init(){}
}

// @DataContract
public class Report : Report
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class Report : Codable
{
    // @DataMember(Name="data")
    public var data:[ReportData]

    // @DataMember(Name="executionTimeMs")
    public var executionTimeMs:Int

    // @DataMember(Name="totalItems")
    public var totalItems:Int

    // @DataMember(Name="errors")
    public var errors:[Error]

    // @DataMember(Name="request")
    public var request:ReportRequest

    // @DataMember(Name="totalClicks")
    public var totalClicks:Int

    required public init(){}
}

// @DataContract
public class ReportData : Codable
{
    // @DataMember(Name="id")
    public var id:String

    // @DataMember(Name="item")
    public var item:Item

    // @DataMember(Name="totalClicks")
    public var totalClicks:UInt64

    // @DataMember(Name="clicks")
    public var clicks:UInt64

    // @DataMember(Name="junkClicks")
    public var junkClicks:UInt64

    // @DataMember(Name="spiderClicks")
    public var spiderClicks:UInt64

    // @DataMember(Name="dateUtc")
    public var dateUtc:Date

    required public init(){}
}

// @DataContract
public class Item : Codable
{
    // @DataMember(Name="id")
    public var id:String

    // @DataMember(Name="displayName")
    public var displayName:String

    required public init(){}
}

// @DataContract
public class Error : Codable
{
    // @DataMember(Name="code")
    public var code:String

    required public init(){}
}

// @DataContract
public class ReportRequest : Codable
{
    // @DataMember(Name="items")
    public var items:[String]

    // @DataMember(Name="groupBy")
    public var groupBy:[GroupBy]

    // @DataMember(Name="attribute")
    public var attribute:String

    // @DataMember(Name="type")
    public var type:ReportType

    // @DataMember(Name="fromStartUtcInclusive")
    public var fromStartUtcInclusive:Date

    // @DataMember(Name="fromEndUtcInclusive")
    public var fromEndUtcInclusive:Date

    // @DataMember(Name="retailers")
    public var retailers:[String]

    required public init(){}
}

public enum GroupBy : String, Codable
{
    case Default
    case Retailer
    case Date
}

public enum ReportType : String, Codable
{
    case ShortUrl
    case Group
    case User
}

Swift GetLinkReportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}