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
namespace GeniuslinkAPI.ServiceModel.V4.Reporting.DTOs

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    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 PostLinkReportRequest() = 
        [<DataMember(Name="reports")>]
        member val Reports:IEnumerable<ReportRequest> = null with get,set

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

    [<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 PostLinkReportResponse() = 
        [<DataMember(Name="responseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

        [<DataMember(Name="reports")>]
        member val Reports:IEnumerable<Report> = null with get,set

F# PostLinkReportRequest DTOs

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: geniuslink-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/GeniuslinkAPI.ServiceModel.V4.Reporting.Requests">
  <reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Reporting.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/GeniuslinkAPI.ServiceModel.V4.Reporting.Responses">
  <reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Reporting.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>