ShortlinksAPI

<back to all web services

GetShortLinkMetadataRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links/metadata/{baseCode}
GetShortLinkMetadataRequest Parameters:
NameParameterData TypeRequiredDescription
BaseCodepathstringNo
GetShortLinkMetadataResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DataformUserShortLinkNo
UserShortLink Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DestinationUrlformstringNo
ShortUrlCodeformstringNo
DomainformstringNo
LinkTypeformstringNo
HasOverrideformboolNo
ProductUrlformstringNo
TrackingCodeformstringNo
SkipAffiliateRedirectformboolNo
CreatedUtcformDateTimeNo
UpdatedUtcformDateTimeNo
NotesformstringNo
CreatedUserTimeformDateTimeNo
UpdatedUserTimeformDateTimeNo
Tsidformuint?No
GroupformstringNo
UsernameformstringNo
JsonMetadataformstringNo
JsonItemMetadataformstringNo
JsonPostProcessingRulesformstringNo
JsonOverridesformstringNo
TotalClicksformdecimalNo
AdvertiserformstringNo
AdvertiserIdformuintNo
PercentChangePeriodOverPeriodformdecimalNo
PreviousPeriodTotalClicksformdecimalNo
IsArchivedformuintNo
IsArchivedIntformintNo
FetchMetadataformboolNo
ProductDisplayName1formstringNo
ProductDisplayName2formstringNo
ProductDisplayName3formstringNo
ProductArtworkThumbnailUrlformstringNo
ProductArtworkThumbnailUrl100formstringNo
AdvertiserIconformstringNo
AdvertiserIconCssClassformstringNo
IsGeniusformboolNo
AdvertiserIconTitleformstringNo
TrackingPixelIdsformstringNo
ApplePreferenceformuintNo
AliasesformList<ShortUrlAlias>No
LinkCreatorSettingformLinkCreatorOptionNo
ShortUrlAlias Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DomainformstringNo
BaseCodeformstringNo
LastUpdatedUtcformDateTimeNo
LinkCreatorOption Enum:
NotSet
Simple
Split
Advanced
Interstitial
Other

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v4/links/metadata/{baseCode} HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}