| GET | /v4/links/metadata/list |
|---|
"use strict";
export class ShortUrlAlias {
/** @param {{code?:string,domain?:string,baseCode?:string,lastUpdatedUtc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
code;
/** @type {string} */
domain;
/** @type {string} */
baseCode;
/** @type {string} */
lastUpdatedUtc;
}
/** @typedef {'NotSet'|'Simple'|'Split'|'Advanced'|'Interstitial'|'Other'} */
export var LinkCreatorOption;
(function (LinkCreatorOption) {
LinkCreatorOption["NotSet"] = "NotSet"
LinkCreatorOption["Simple"] = "Simple"
LinkCreatorOption["Split"] = "Split"
LinkCreatorOption["Advanced"] = "Advanced"
LinkCreatorOption["Interstitial"] = "Interstitial"
LinkCreatorOption["Other"] = "Other"
})(LinkCreatorOption || (LinkCreatorOption = {}));
export class UserShortLink {
/** @param {{id?:number,destinationUrl?:string,shortUrlCode?:string,domain?:string,linkType?:string,hasOverride?:boolean,productUrl?:string,trackingCode?:string,skipAffiliateRedirect?:boolean,createdUtc?:string,updatedUtc?:string,notes?:string,createdUserTime?:string,updatedUserTime?:string,tsid?:number,group?:string,username?:string,jsonMetadata?:string,jsonItemMetadata?:string,jsonPostProcessingRules?:string,jsonOverrides?:string,totalClicks?:number,advertiser?:string,advertiserId?:number,percentChangePeriodOverPeriod?:number,previousPeriodTotalClicks?:number,isArchived?:number,isArchivedInt?:number,fetchMetadata?:boolean,productDisplayName1?:string,productDisplayName2?:string,productDisplayName3?:string,productArtworkThumbnailUrl?:string,productArtworkThumbnailUrl100?:string,advertiserIcon?:string,advertiserIconCssClass?:string,isGenius?:boolean,advertiserIconTitle?:string,trackingPixelIds?:string,applePreference?:number,aliases?:ShortUrlAlias[],linkCreatorSetting?:LinkCreatorOption}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
destinationUrl;
/** @type {string} */
shortUrlCode;
/** @type {string} */
domain;
/** @type {string} */
linkType;
/** @type {boolean} */
hasOverride;
/** @type {string} */
productUrl;
/** @type {string} */
trackingCode;
/** @type {boolean} */
skipAffiliateRedirect;
/** @type {string} */
createdUtc;
/** @type {string} */
updatedUtc;
/** @type {string} */
notes;
/** @type {string} */
createdUserTime;
/** @type {string} */
updatedUserTime;
/** @type {?number} */
tsid;
/** @type {string} */
group;
/** @type {string} */
username;
/** @type {string} */
jsonMetadata;
/** @type {string} */
jsonItemMetadata;
/** @type {string} */
jsonPostProcessingRules;
/** @type {string} */
jsonOverrides;
/** @type {number} */
totalClicks;
/** @type {string} */
advertiser;
/** @type {number} */
advertiserId;
/** @type {number} */
percentChangePeriodOverPeriod;
/** @type {number} */
previousPeriodTotalClicks;
/** @type {number} */
isArchived;
/** @type {number} */
isArchivedInt;
/** @type {boolean} */
fetchMetadata;
/** @type {string} */
productDisplayName1;
/** @type {string} */
productDisplayName2;
/** @type {string} */
productDisplayName3;
/** @type {string} */
productArtworkThumbnailUrl;
/** @type {string} */
productArtworkThumbnailUrl100;
/** @type {string} */
advertiserIcon;
/** @type {string} */
advertiserIconCssClass;
/** @type {boolean} */
isGenius;
/** @type {string} */
advertiserIconTitle;
/** @type {string} */
trackingPixelIds;
/** @type {number} */
applePreference;
/** @type {ShortUrlAlias[]} */
aliases;
/** @type {LinkCreatorOption} */
linkCreatorSetting;
}
export class GetShortLinksMetadataResponse {
/** @param {{responseStatus?:ResponseStatus,data?:UserShortLink[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {UserShortLink[]} */
data;
}
export class GetShortLinksMetadataRequest {
/** @param {{ids?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string[]} */
ids;
}
JavaScript GetShortLinksMetadataRequest DTOs
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.
GET /v4/links/metadata/list HTTP/1.1 Host: shortlinks-api.qa.platform.georiot.com Accept: text/jsv
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
}
},
data:
[
{
id: 0,
destinationUrl: String,
shortUrlCode: String,
domain: String,
linkType: NotSet,
hasOverride: False,
productUrl: String,
trackingCode: String,
skipAffiliateRedirect: False,
createdUtc: 0001-01-01,
updatedUtc: 0001-01-01,
notes: String,
createdUserTime: 0001-01-01,
updatedUserTime: 0001-01-01,
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-01
}
],
linkCreatorSetting: NotSet
}
]
}