GeniuslinkAPI

<back to all web services

PostLinkReportRequest

import Foundation
import ServiceStack

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

    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
}

// @DataContract
public class PostLinkReportResponse : Codable
{
    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

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

    required public init(){}
}

// @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(){}
}

Swift PostLinkReportRequest DTOs

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>