ReportingAPI

<back to all web services

PostLinkReportRequest

Requires Authentication
The following routes are available for this service:
POST/v4/report/links
import Foundation
import ServiceStack

// @DataContract
public class PostLinkReportRequest : IPostLinkReportRequest, 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 : IPostLinkReportResponse, Codable
{
    // @DataMember(Name="reports")
    public var reports:[Report]

    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

    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

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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