GeniuslinkAPI

<back to all web services

PostLinkReportRequest

Requires Authentication
The following routes are available for this service:
POST/v4/report/links
POST/v3.5/report/links
PostLinkReportRequest Parameters:
NameParameterData TypeRequiredDescription
ReportsbodyIEnumerable<ReportRequest>No
ReportRequest Parameters:
NameParameterData TypeRequiredDescription
ItemsformIEnumerable<string>No
GroupByformIEnumerable<GroupBy>No
AttributeformstringNo
TypeformReportTypeNo
FromStartUtcInclusiveformDateTimeNo
FromEndUtcInclusiveformDateTimeNo
RetailersformIEnumerable<string>No
GroupBy Enum:
Default
Retailer
Date
ReportType Enum:
ShortUrl
Group
User
PostLinkReportResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ReportsformIEnumerable<Report>No
Report Parameters:
NameParameterData TypeRequiredDescription
DataformList<ReportData>No
ExecutionTimeMsformlongNo
TotalItemsformlongNo
ErrorsformList<Error>No
RequestformReportRequestNo
TotalClicksformlongNo
ReportData Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ItemformItemNo
TotalClicksformulongNo
ActualClicksformulongNo
JunkClicksformulongNo
SpiderClicksformulongNo
DateUtcformDateTimeNo
Item Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DisplayNameformstringNo
Error Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo

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.

POST /v4/report/links HTTP/1.1 
Host: geniuslink-api-zane.dev.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}