ReportingAPI

<back to all web services

PostLinkReportRequest

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class PostLinkReportRequest : IPostLinkReportRequest
{
    @DataMember(Name="reports")
    @SerializedName("reports")
    override var reports:ArrayList<ReportRequest>? = null
}

@DataContract
open class ReportRequest
{
    @DataMember(Name="items")
    @SerializedName("items")
    open var items:ArrayList<String>? = null

    @DataMember(Name="groupBy")
    @SerializedName("groupBy")
    open var groupBy:ArrayList<GroupBy>? = null

    @DataMember(Name="attribute")
    @SerializedName("attribute")
    open var attribute:String? = null

    @DataMember(Name="type")
    @SerializedName("type")
    open var Type:ReportType? = null

    @DataMember(Name="fromStartUtcInclusive")
    @SerializedName("fromStartUtcInclusive")
    open var fromStartUtcInclusive:Date? = null

    @DataMember(Name="fromEndUtcInclusive")
    @SerializedName("fromEndUtcInclusive")
    open var fromEndUtcInclusive:Date? = null

    @DataMember(Name="retailers")
    @SerializedName("retailers")
    open var retailers:ArrayList<String>? = null
}

enum class GroupBy
{
    Default,
    Retailer,
    Date,
}

enum class ReportType
{
    ShortUrl,
    Group,
    User,
}

@DataContract
open class PostLinkReportResponse : IPostLinkReportResponse
{
    @DataMember(Name="reports")
    @SerializedName("reports")
    override var reports:ArrayList<Report>? = null

    @DataMember(Name="responseStatus")
    @SerializedName("responseStatus")
    open var responseStatus:ResponseStatus? = null
}

@DataContract
open class Report
{
    @DataMember(Name="data")
    @SerializedName("data")
    open var Data:ArrayList<ReportData>? = null

    @DataMember(Name="executionTimeMs")
    @SerializedName("executionTimeMs")
    open var executionTimeMs:Long? = null

    @DataMember(Name="totalItems")
    @SerializedName("totalItems")
    open var totalItems:Long? = null

    @DataMember(Name="errors")
    @SerializedName("errors")
    open var errors:ArrayList<Error>? = null

    @DataMember(Name="request")
    @SerializedName("request")
    open var request:ReportRequest? = null

    @DataMember(Name="totalClicks")
    @SerializedName("totalClicks")
    open var totalClicks:Long? = null
}

@DataContract
open class ReportData
{
    @DataMember(Name="id")
    @SerializedName("id")
    open var id:String? = null

    @DataMember(Name="item")
    @SerializedName("item")
    open var item:Item? = null

    @DataMember(Name="totalClicks")
    @SerializedName("totalClicks")
    open var totalClicks:BigInteger? = null

    @DataMember(Name="clicks")
    @SerializedName("clicks")
    open var actualClicks:BigInteger? = null

    @DataMember(Name="junkClicks")
    @SerializedName("junkClicks")
    open var junkClicks:BigInteger? = null

    @DataMember(Name="spiderClicks")
    @SerializedName("spiderClicks")
    open var spiderClicks:BigInteger? = null

    @DataMember(Name="dateUtc")
    @SerializedName("dateUtc")
    open var dateUtc:Date? = null
}

@DataContract
open class Item
{
    @DataMember(Name="id")
    @SerializedName("id")
    open var id:String? = null

    @DataMember(Name="displayName")
    @SerializedName("displayName")
    open var displayName:String? = null
}

@DataContract
open class Error
{
    @DataMember(Name="code")
    @SerializedName("code")
    open var code:String? = null
}

Kotlin PostLinkReportRequest DTOs

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>