ShortlinksAPI

GetLinkMetadataRequest

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetLinkMetadataRequest
{
    @DataMember(Name="domain")
    @SerializedName("domain")
    open var aliasDomain:String? = null

    @DataMember(Name="code")
    @SerializedName("code")
    open var aliasCode:String? = null
}

@DataContract
open class GetLinkMetadataResponse
{
    @DataMember(Name="data")
    @SerializedName("data")
    open var Data:UserShortLink? = null

    @DataMember(Name="responseStatus")
    @SerializedName("responseStatus")
    open var responseStatus:ResponseStatus? = null
}

@DataContract
open class UserShortLink : IUserShortLink
{
    @DataMember
    open var id:Long? = null

    @DataMember
    override var destinationUrl:String? = null

    @DataMember
    override var shortUrlCode:String? = null

    @DataMember
    override var domain:String? = null

    @DataMember
    override var linkType:String? = null

    @DataMember
    open var hasOverride:Boolean? = null

    @DataMember
    override var productUrl:String? = null

    @DataMember
    open var trackingCode:String? = null

    @DataMember
    open var skipAffiliateRedirect:Boolean? = null

    @DataMember
    open var createdUtc:Date? = null

    @DataMember
    open var updatedUtc:Date? = null

    @DataMember
    open var notes:String? = null

    @DataMember
    open var createdUserTime:Date? = null

    @DataMember
    open var updatedUserTime:Date? = null

    @DataMember
    override var tsid:Long? = null

    @DataMember
    open var group:String? = null

    @DataMember
    open var username:String? = null

    @DataMember
    open var jsonMetadata:String? = null

    @DataMember
    open var jsonItemMetadata:String? = null

    @DataMember
    open var jsonPostProcessingRules:String? = null

    @DataMember
    override var jsonOverrides:String? = null

    @DataMember
    open var totalClicks:BigDecimal? = null

    @DataMember
    override var advertiser:String? = null

    @DataMember
    open var advertiserId:Long? = null

    @DataMember
    open var percentChangePeriodOverPeriod:BigDecimal? = null

    @DataMember
    open var previousPeriodTotalClicks:BigDecimal? = null

    @DataMember
    open var isArchived:Long? = null

    @DataMember
    open var isArchivedInt:Int? = null

    @DataMember
    open var fetchMetadata:Boolean? = null

    @DataMember
    override var productDisplayName1:String? = null

    @DataMember
    override var productDisplayName2:String? = null

    @DataMember
    open var productDisplayName3:String? = null

    @DataMember
    override var productArtworkThumbnailUrl:String? = null

    @DataMember
    override var productArtworkThumbnailUrl100:String? = null

    @DataMember
    open var advertiserIcon:String? = null

    @DataMember
    open var advertiserIconCssClass:String? = null

    @DataMember
    open var isGenius:Boolean? = null

    @DataMember
    open var advertiserIconTitle:String? = null

    @DataMember
    open var trackingPixelIds:String? = null

    @DataMember
    open var applePreference:Long? = null

    @DataMember
    open var aliases:ArrayList<ShortUrlAlias>? = null

    @DataMember
    open var linkCreatorSetting:LinkCreatorOption? = null
}

@DataContract
open class ShortUrlAlias : IShortUrlAlias
{
    @DataMember
    override var code:String? = null

    @DataMember
    override var domain:String? = null

    @DataMember
    override var baseCode:String? = null

    @DataMember
    override var lastUpdatedUtc:Date? = null
}

enum class LinkCreatorOption
{
    NotSet,
    Simple,
    Split,
    Advanced,
    Interstitial,
    Other,
}

Kotlin GetLinkMetadataRequest DTOs

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

{
	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
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}