Booklinker.API

GetLinkReportRequest

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

**GetLinkReportRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BaseCode	query	string	No

**GetLinkReportResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Report	form	ClickReport	No
ResponseStatus	form	ResponseStatus	No

**ClickReport** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Reports	form	Dictionary<string, Report>	No
TotalClicks	form	ulong	No

**Report** Parameters:
Name	Parameter	Data Type	Required
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

**ReportData** Parameters:
Name	Parameter	Data Type	Required
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

**Item** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
DisplayName	form	string	No

**Error** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No

**ReportRequest** Parameters:
Name	Parameter	Data Type	Required
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

**GroupBy** Enum:
Default
Retailer
Date

**ReportType** Enum:
ShortUrl
Group
User

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