Booklinker.API

<back to all web services

GetLinkReportRequest

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

namespace Booklinker.API.ServiceModel.V1.DTOs
{
    [DataContract]
    public partial class ClickReport
    {
        [DataMember(Name="code")]
        public virtual string Code { get; set; }

        [DataMember(Name="reports")]
        public virtual Dictionary<string, Report> Reports { get; set; }

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

    [DataContract]
    public partial class Report
        : Report
    {
    }

}

namespace Booklinker.API.ServiceModel.V1.Requests
{
    [DataContract]
    public partial class GetLinkReportRequest
    {
        [DataMember(Name="baseCode")]
        public virtual string BaseCode { get; set; }
    }

}

namespace Booklinker.API.ServiceModel.V1.Responses
{
    [DataContract]
    public partial class GetLinkReportResponse
    {
        [DataMember(Name="reports")]
        public virtual ClickReport Report { get; set; }

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

}

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; }
    }

}

C# GetLinkReportRequest DTOs

GET /v1/links/report HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	reports: 
	{
		code: String,
		reports: 
		{
			String: 
			{
				data: 
				[
					{
						id: String,
						item: 
						{
							id: String,
							displayName: String
						},
						totalClicks: 0,
						clicks: 0,
						junkClicks: 0,
						spiderClicks: 0,
						dateUtc: 0001-01-01
					}
				],
				executionTimeMs: 0,
				totalItems: 1,
				errors: 
				[
					{
						
					}
				],
				request: 
				{
					attribute: String,
					type: ShortUrl,
					fromStartUtcInclusive: 0001-01-01,
					fromEndUtcInclusive: 0001-01-01
				},
				totalClicks: 0
			}
		},
		totalClicks: 0
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}