ShortlinksAPI

GetShortLinkMetadataRequest

The following routes are available for this service:
GET	/v4/links/metadata/{baseCode}

**GetShortLinkMetadataRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BaseCode	path	string	No

**GetShortLinkMetadataResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Data	form	UserShortLink	No

**UserShortLink** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
DestinationUrl	form	string	No
ShortUrlCode	form	string	No
Domain	form	string	No
LinkType	form	string	No
HasOverride	form	bool	No
ProductUrl	form	string	No
TrackingCode	form	string	No
SkipAffiliateRedirect	form	bool	No
CreatedUtc	form	DateTime	No
UpdatedUtc	form	DateTime	No
Notes	form	string	No
CreatedUserTime	form	DateTime	No
UpdatedUserTime	form	DateTime	No
Tsid	form	uint?	No
Group	form	string	No
Username	form	string	No
JsonMetadata	form	string	No
JsonItemMetadata	form	string	No
JsonPostProcessingRules	form	string	No
JsonOverrides	form	string	No
TotalClicks	form	decimal	No
Advertiser	form	string	No
AdvertiserId	form	uint	No
PercentChangePeriodOverPeriod	form	decimal	No
PreviousPeriodTotalClicks	form	decimal	No
IsArchived	form	uint	No
IsArchivedInt	form	int	No
FetchMetadata	form	bool	No
ProductDisplayName1	form	string	No
ProductDisplayName2	form	string	No
ProductDisplayName3	form	string	No
ProductArtworkThumbnailUrl	form	string	No
ProductArtworkThumbnailUrl100	form	string	No
AdvertiserIcon	form	string	No
AdvertiserIconCssClass	form	string	No
IsGenius	form	bool	No
AdvertiserIconTitle	form	string	No
TrackingPixelIds	form	string	No
ApplePreference	form	uint	No
Aliases	form	List<ShortUrlAlias>	No
LinkCreatorSetting	form	LinkCreatorOption	No

**ShortUrlAlias** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Domain	form	string	No
BaseCode	form	string	No
LastUpdatedUtc	form	DateTime	No

**LinkCreatorOption** Enum:
NotSet
Simple
Split
Advanced
Interstitial
Other

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

HTTP + JSV

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: 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
	}
}