| POST | /v4/report/links | ||
|---|---|---|---|
| POST | /v3.5/report/links |
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using GeniuslinkAPI.ServiceModel.V4.Reporting.Requests;
using GeniuslinkAPI.ServiceModel.V4.Reporting.DTOs;
using GeniuslinkAPI.ServiceModel.V4.Reporting.Responses;
using GeniuslinkAPI.ServiceModel.V4.Reporting.DTOs.Items;
namespace GeniuslinkAPI.ServiceModel.V4.Reporting.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 GeniuslinkAPI.ServiceModel.V4.Reporting.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 GeniuslinkAPI.ServiceModel.V4.Reporting.Requests
{
[DataContract]
public partial class PostLinkReportRequest
{
[DataMember(Name="reports")]
public virtual IEnumerable<ReportRequest> Reports { get; set; }
}
}
namespace GeniuslinkAPI.ServiceModel.V4.Reporting.Responses
{
[DataContract]
public partial class PostLinkReportResponse
{
[DataMember(Name="responseStatus")]
public virtual ResponseStatus ResponseStatus { get; set; }
[DataMember(Name="reports")]
public virtual IEnumerable<Report> Reports { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: geniuslink-api-zane.dev.platform.georiot.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}