ReportingAPI

<back to all web services

PostLinkReportRequest

Requires Authentication
The following routes are available for this service:
POST/v4/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
ReportsformIEnumerable<Report>No
ResponseStatusformResponseStatusNo
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PostLinkReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReportingAPI.ServiceModel.V1.Requests">
  <reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/Geniuslink.Reporting.Contracts.V1.DTOs" i:nil="true" />
</PostLinkReportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostLinkReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReportingAPI.ServiceModel.V1.Responses">
  <reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/Geniuslink.Reporting.Contracts.V1.DTOs" i:nil="true" />
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
</PostLinkReportResponse>