ShortlinksAPI

<back to all web services

GetShortLinksMetadataRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links/metadata/list

// @DataContract
export class ShortUrlAlias implements IShortUrlAlias
{
    // @DataMember
    public code: string;

    // @DataMember
    public domain: string;

    // @DataMember
    public baseCode: string;

    // @DataMember
    public lastUpdatedUtc: string;

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

export enum LinkCreatorOption
{
    NotSet = 'NotSet',
    Simple = 'Simple',
    Split = 'Split',
    Advanced = 'Advanced',
    Interstitial = 'Interstitial',
    Other = 'Other',
}

// @DataContract
export class UserShortLink implements IUserShortLink
{
    // @DataMember
    public id: number;

    // @DataMember
    public destinationUrl: string;

    // @DataMember
    public shortUrlCode: string;

    // @DataMember
    public domain: string;

    // @DataMember
    public linkType: string;

    // @DataMember
    public hasOverride: boolean;

    // @DataMember
    public productUrl: string;

    // @DataMember
    public trackingCode: string;

    // @DataMember
    public skipAffiliateRedirect: boolean;

    // @DataMember
    public createdUtc: string;

    // @DataMember
    public updatedUtc: string;

    // @DataMember
    public notes: string;

    // @DataMember
    public createdUserTime: string;

    // @DataMember
    public updatedUserTime: string;

    // @DataMember
    public tsid?: number;

    // @DataMember
    public group: string;

    // @DataMember
    public username: string;

    // @DataMember
    public jsonMetadata: string;

    // @DataMember
    public jsonItemMetadata: string;

    // @DataMember
    public jsonPostProcessingRules: string;

    // @DataMember
    public jsonOverrides: string;

    // @DataMember
    public totalClicks: number;

    // @DataMember
    public advertiser: string;

    // @DataMember
    public advertiserId: number;

    // @DataMember
    public percentChangePeriodOverPeriod: number;

    // @DataMember
    public previousPeriodTotalClicks: number;

    // @DataMember
    public isArchived: number;

    // @DataMember
    public isArchivedInt: number;

    // @DataMember
    public fetchMetadata: boolean;

    // @DataMember
    public productDisplayName1: string;

    // @DataMember
    public productDisplayName2: string;

    // @DataMember
    public productDisplayName3: string;

    // @DataMember
    public productArtworkThumbnailUrl: string;

    // @DataMember
    public productArtworkThumbnailUrl100: string;

    // @DataMember
    public advertiserIcon: string;

    // @DataMember
    public advertiserIconCssClass: string;

    // @DataMember
    public isGenius: boolean;

    // @DataMember
    public advertiserIconTitle: string;

    // @DataMember
    public trackingPixelIds: string;

    // @DataMember
    public applePreference: number;

    // @DataMember
    public aliases: ShortUrlAlias[];

    // @DataMember
    public linkCreatorSetting: LinkCreatorOption;

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

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

    // @DataMember(Name="data")
    public data: UserShortLink[];

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

// @DataContract
export class GetShortLinksMetadataRequest implements IGetShortLinksMetadataRequest
{
    // @DataMember(Name="ids")
    public ids: string[];

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

TypeScript GetShortLinksMetadataRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v4/links/metadata/list HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/csv

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

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"data":[{"id":0,"destinationUrl":"String","shortUrlCode":"String","domain":"String","linkType":"NotSet","hasOverride":false,"productUrl":"String","trackingCode":"String","skipAffiliateRedirect":false,"createdUtc":"0001-01-01T00:00:00.0000000","updatedUtc":"0001-01-01T00:00:00.0000000","notes":"String","createdUserTime":"0001-01-01T00:00:00.0000000","updatedUserTime":"0001-01-01T00:00:00.0000000","tsid":0,"group":"String","username":"String","jsonMetadata":"String","jsonItemMetadata":"String","jsonPostProcessingRules":"String","jsonOverrides":"String","totalClicks":0,"advertiser":"String","advertiserId":0,"percentChangePeriodOverPeriod":0,"previousPeriodTotalClicks":0,"isArchived":0,"isArchivedInt":0,"fetchMetadata":false,"productDisplayName1":"String","productDisplayName2":"String","productDisplayName3":"String","productArtworkThumbnailUrl":"String","productArtworkThumbnailUrl100":"String","advertiserIcon":"String","advertiserIconCssClass":"String","isGenius":false,"advertiserIconTitle":"String","trackingPixelIds":"String","applePreference":0,"aliases":[{"code":"String","domain":"String","baseCode":"String","lastUpdatedUtc":"0001-01-01T00:00:00.0000000"}],"linkCreatorSetting":"NotSet"}]}