GeniuslinkAPI

<back to all web services

PostLinkReportRequest

export enum GroupBy
{
    Default = 'Default',
    Retailer = 'Retailer',
    Date = 'Date',
}

export enum ReportType
{
    ShortUrl = 'ShortUrl',
    Group = 'Group',
    User = 'User',
}

// @DataContract
export class ReportRequest
{
    // @DataMember(Name="items")
    public items: string[];

    // @DataMember(Name="groupBy")
    public groupBy: GroupBy[];

    // @DataMember(Name="attribute")
    public attribute: string;

    // @DataMember(Name="type")
    public type: ReportType;

    // @DataMember(Name="fromStartUtcInclusive")
    public fromStartUtcInclusive: string;

    // @DataMember(Name="fromEndUtcInclusive")
    public fromEndUtcInclusive: string;

    // @DataMember(Name="retailers")
    public retailers: string[];

    public constructor(init?: Partial<ReportRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PostLinkReportRequest
{
    // @DataMember(Name="reports")
    public reports: ReportRequest[];

    public constructor(init?: Partial<PostLinkReportRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Item
{
    // @DataMember(Name="id")
    public id: string;

    // @DataMember(Name="displayName")
    public displayName: string;

    public constructor(init?: Partial<Item>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ReportData
{
    // @DataMember(Name="id")
    public id: string;

    // @DataMember(Name="item")
    public item: Item;

    // @DataMember(Name="totalClicks")
    public totalClicks: number;

    // @DataMember(Name="clicks")
    public clicks: number;

    // @DataMember(Name="junkClicks")
    public junkClicks: number;

    // @DataMember(Name="spiderClicks")
    public spiderClicks: number;

    // @DataMember(Name="dateUtc")
    public dateUtc: string;

    public constructor(init?: Partial<ReportData>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Error
{
    // @DataMember(Name="code")
    public code: string;

    public constructor(init?: Partial<Error>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Report
{
    // @DataMember(Name="data")
    public data: ReportData[];

    // @DataMember(Name="executionTimeMs")
    public executionTimeMs: number;

    // @DataMember(Name="totalItems")
    public totalItems: number;

    // @DataMember(Name="errors")
    public errors: Error[];

    // @DataMember(Name="request")
    public request: ReportRequest;

    // @DataMember(Name="totalClicks")
    public totalClicks: number;

    public constructor(init?: Partial<Report>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PostLinkReportResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    // @DataMember(Name="reports")
    public reports: Report[];

    public constructor(init?: Partial<PostLinkReportResponse>) { (Object as any).assign(this, init); }
}

TypeScript PostLinkReportRequest DTOs

POST /v4/report/links HTTP/1.1 
Host: geniuslink-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/GeniuslinkAPI.ServiceModel.V4.Reporting.Requests">
  <reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Reporting.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/GeniuslinkAPI.ServiceModel.V4.Reporting.Responses">
  <reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Reporting.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>