ReportingAPI

<back to all web services

PostLinkReportRequest

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ReportingAPI.ServiceModel.V1.Requests;
using Geniuslink.Reporting.Contracts.V1.DTOs;
using ReportingAPI.ServiceModel.V1.Responses;
using Geniuslink.Reporting.Contracts.V1.DTOs.Items;

namespace Geniuslink.Reporting.Contracts.V1.DTOs
{
    [DataContract]
    public partial class Error
    {
        [DataMember(Name="code")]
        public virtual string Code { get; set; }
    }

    public enum GroupBy
    {
        Default,
        Retailer,
        Date,
    }

    [DataContract]
    public partial class Report
    {
        [DataMember(Name="data")]
        public virtual List<ReportData> Data { get; set; }

        [DataMember(Name="executionTimeMs")]
        public virtual long ExecutionTimeMs { get; set; }

        [DataMember(Name="totalItems")]
        public virtual long TotalItems { get; set; }

        [DataMember(Name="errors")]
        public virtual List<Error> Errors { get; set; }

        [DataMember(Name="request")]
        public virtual ReportRequest Request { get; set; }

        [DataMember(Name="totalClicks")]
        public virtual long TotalClicks { get; set; }
    }

    [DataContract]
    public partial class ReportData
    {
        [DataMember(Name="id")]
        public virtual string Id { get; set; }

        [DataMember(Name="item")]
        public virtual Item Item { get; set; }

        [DataMember(Name="totalClicks")]
        public virtual ulong TotalClicks { get; set; }

        [DataMember(Name="clicks")]
        public virtual ulong ActualClicks { get; set; }

        [DataMember(Name="junkClicks")]
        public virtual ulong JunkClicks { get; set; }

        [DataMember(Name="spiderClicks")]
        public virtual ulong SpiderClicks { get; set; }

        [DataMember(Name="dateUtc")]
        public virtual DateTime DateUtc { get; set; }
    }

    [DataContract]
    public partial class ReportRequest
    {
        [DataMember(Name="items")]
        public virtual IEnumerable<string> Items { get; set; }

        [DataMember(Name="groupBy")]
        public virtual IEnumerable<GroupBy> GroupBy { get; set; }

        [DataMember(Name="attribute")]
        public virtual string Attribute { get; set; }

        [DataMember(Name="type")]
        public virtual ReportType Type { get; set; }

        [DataMember(Name="fromStartUtcInclusive")]
        public virtual DateTime FromStartUtcInclusive { get; set; }

        [DataMember(Name="fromEndUtcInclusive")]
        public virtual DateTime FromEndUtcInclusive { get; set; }

        [DataMember(Name="retailers")]
        public virtual IEnumerable<string> Retailers { get; set; }
    }

    public enum ReportType
    {
        ShortUrl,
        Group,
        User,
    }

}

namespace Geniuslink.Reporting.Contracts.V1.DTOs.Items
{
    [DataContract]
    public partial class Item
    {
        [DataMember(Name="id")]
        public virtual string Id { get; set; }

        [DataMember(Name="displayName")]
        public virtual string DisplayName { get; set; }
    }

}

namespace ReportingAPI.ServiceModel.V1.Requests
{
    [DataContract]
    public partial class PostLinkReportRequest
        : IPostLinkReportRequest
    {
        [DataMember(Name="reports")]
        public virtual IEnumerable<ReportRequest> Reports { get; set; }
    }

}

namespace ReportingAPI.ServiceModel.V1.Responses
{
    [DataContract]
    public partial class PostLinkReportResponse
        : IPostLinkReportResponse
    {
        [DataMember(Name="reports")]
        public virtual IEnumerable<Report> Reports { get; set; }

        [DataMember(Name="responseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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>