ShortlinksAPI

<back to all web services

GetShortLinksMetadataRequest

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

// @DataContract
public class GetShortLinksMetadataRequest : IGetShortLinksMetadataRequest, Codable
{
    // @DataMember(Name="ids")
    public var ids:[String]

    required public init(){}
}

// @DataContract
public class GetShortLinksMetadataResponse : IGetShortLinksMetadataResponse, Codable
{
    // @DataMember(Name="responseStatus")
    public var responseStatus:ResponseStatus

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

    required public init(){}
}

// @DataContract
public class UserShortLink : IUserShortLink, Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var destinationUrl:String

    // @DataMember
    public var shortUrlCode:String

    // @DataMember
    public var domain:String

    // @DataMember
    public var linkType:String

    // @DataMember
    public var hasOverride:Bool

    // @DataMember
    public var productUrl:String

    // @DataMember
    public var trackingCode:String

    // @DataMember
    public var skipAffiliateRedirect:Bool

    // @DataMember
    public var createdUtc:Date

    // @DataMember
    public var updatedUtc:Date

    // @DataMember
    public var notes:String

    // @DataMember
    public var createdUserTime:Date

    // @DataMember
    public var updatedUserTime:Date

    // @DataMember
    public var tsid:UInt32?

    // @DataMember
    public var group:String

    // @DataMember
    public var username:String

    // @DataMember
    public var jsonMetadata:String

    // @DataMember
    public var jsonItemMetadata:String

    // @DataMember
    public var jsonPostProcessingRules:String

    // @DataMember
    public var jsonOverrides:String

    // @DataMember
    public var totalClicks:Double

    // @DataMember
    public var advertiser:String

    // @DataMember
    public var advertiserId:UInt32

    // @DataMember
    public var percentChangePeriodOverPeriod:Double

    // @DataMember
    public var previousPeriodTotalClicks:Double

    // @DataMember
    public var isArchived:UInt32

    // @DataMember
    public var isArchivedInt:Int

    // @DataMember
    public var fetchMetadata:Bool

    // @DataMember
    public var productDisplayName1:String

    // @DataMember
    public var productDisplayName2:String

    // @DataMember
    public var productDisplayName3:String

    // @DataMember
    public var productArtworkThumbnailUrl:String

    // @DataMember
    public var productArtworkThumbnailUrl100:String

    // @DataMember
    public var advertiserIcon:String

    // @DataMember
    public var advertiserIconCssClass:String

    // @DataMember
    public var isGenius:Bool

    // @DataMember
    public var advertiserIconTitle:String

    // @DataMember
    public var trackingPixelIds:String

    // @DataMember
    public var applePreference:UInt32

    // @DataMember
    public var aliases:[ShortUrlAlias]

    // @DataMember
    public var linkCreatorSetting:LinkCreatorOption

    required public init(){}
}

// @DataContract
public class ShortUrlAlias : IShortUrlAlias, Codable
{
    // @DataMember
    public var code:String

    // @DataMember
    public var domain:String

    // @DataMember
    public var baseCode:String

    // @DataMember
    public var lastUpdatedUtc:Date

    required public init(){}
}

public enum LinkCreatorOption : String, Codable
{
    case NotSet
    case Simple
    case Split
    case Advanced
    case Interstitial
    case Other
}

Swift GetShortLinksMetadataRequest 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/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
		}
	]
}