ShortlinksAPI

<back to all web services

GetShortLinksMetadataRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links/metadata/list
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @DataContract
    public static class GetShortLinksMetadataRequest implements IGetShortLinksMetadataRequest
    {
        @DataMember(Name="ids")
        @SerializedName("ids")
        public ArrayList<String> ids = null;
        
        public ArrayList<String> getIds() { return ids; }
        public GetShortLinksMetadataRequest setIds(ArrayList<String> value) { this.ids = value; return this; }
    }

    @DataContract
    public static class GetShortLinksMetadataResponse implements IGetShortLinksMetadataResponse
    {
        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;

        @DataMember(Name="data")
        @SerializedName("data")
        public ArrayList<UserShortLink> data = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetShortLinksMetadataResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<UserShortLink> getData() { return data; }
        public GetShortLinksMetadataResponse setData(ArrayList<UserShortLink> value) { this.data = value; return this; }
    }

    @DataContract
    public static class UserShortLink implements IUserShortLink
    {
        @DataMember
        public Long id = null;

        @DataMember
        public String destinationUrl = null;

        @DataMember
        public String shortUrlCode = null;

        @DataMember
        public String domain = null;

        @DataMember
        public String linkType = null;

        @DataMember
        public Boolean hasOverride = null;

        @DataMember
        public String productUrl = null;

        @DataMember
        public String trackingCode = null;

        @DataMember
        public Boolean skipAffiliateRedirect = null;

        @DataMember
        public Date createdUtc = null;

        @DataMember
        public Date updatedUtc = null;

        @DataMember
        public String notes = null;

        @DataMember
        public Date createdUserTime = null;

        @DataMember
        public Date updatedUserTime = null;

        @DataMember
        public Long tsid = null;

        @DataMember
        public String group = null;

        @DataMember
        public String username = null;

        @DataMember
        public String jsonMetadata = null;

        @DataMember
        public String jsonItemMetadata = null;

        @DataMember
        public String jsonPostProcessingRules = null;

        @DataMember
        public String jsonOverrides = null;

        @DataMember
        public BigDecimal totalClicks = null;

        @DataMember
        public String advertiser = null;

        @DataMember
        public Long advertiserId = null;

        @DataMember
        public BigDecimal percentChangePeriodOverPeriod = null;

        @DataMember
        public BigDecimal previousPeriodTotalClicks = null;

        @DataMember
        public Long isArchived = null;

        @DataMember
        public Integer isArchivedInt = null;

        @DataMember
        public Boolean fetchMetadata = null;

        @DataMember
        public String productDisplayName1 = null;

        @DataMember
        public String productDisplayName2 = null;

        @DataMember
        public String productDisplayName3 = null;

        @DataMember
        public String productArtworkThumbnailUrl = null;

        @DataMember
        public String productArtworkThumbnailUrl100 = null;

        @DataMember
        public String advertiserIcon = null;

        @DataMember
        public String advertiserIconCssClass = null;

        @DataMember
        public Boolean isGenius = null;

        @DataMember
        public String advertiserIconTitle = null;

        @DataMember
        public String trackingPixelIds = null;

        @DataMember
        public Long applePreference = null;

        @DataMember
        public ArrayList<ShortUrlAlias> aliases = null;

        @DataMember
        public LinkCreatorOption linkCreatorSetting = null;
        
        public Long getId() { return id; }
        public UserShortLink setId(Long value) { this.id = value; return this; }
        public String getDestinationUrl() { return destinationUrl; }
        public UserShortLink setDestinationUrl(String value) { this.destinationUrl = value; return this; }
        public String getShortUrlCode() { return shortUrlCode; }
        public UserShortLink setShortUrlCode(String value) { this.shortUrlCode = value; return this; }
        public String getDomain() { return domain; }
        public UserShortLink setDomain(String value) { this.domain = value; return this; }
        public String getLinkType() { return linkType; }
        public UserShortLink setLinkType(String value) { this.linkType = value; return this; }
        public Boolean isHasOverride() { return hasOverride; }
        public UserShortLink setHasOverride(Boolean value) { this.hasOverride = value; return this; }
        public String getProductUrl() { return productUrl; }
        public UserShortLink setProductUrl(String value) { this.productUrl = value; return this; }
        public String getTrackingCode() { return trackingCode; }
        public UserShortLink setTrackingCode(String value) { this.trackingCode = value; return this; }
        public Boolean isSkipAffiliateRedirect() { return skipAffiliateRedirect; }
        public UserShortLink setSkipAffiliateRedirect(Boolean value) { this.skipAffiliateRedirect = value; return this; }
        public Date getCreatedUtc() { return createdUtc; }
        public UserShortLink setCreatedUtc(Date value) { this.createdUtc = value; return this; }
        public Date getUpdatedUtc() { return updatedUtc; }
        public UserShortLink setUpdatedUtc(Date value) { this.updatedUtc = value; return this; }
        public String getNotes() { return notes; }
        public UserShortLink setNotes(String value) { this.notes = value; return this; }
        public Date getCreatedUserTime() { return createdUserTime; }
        public UserShortLink setCreatedUserTime(Date value) { this.createdUserTime = value; return this; }
        public Date getUpdatedUserTime() { return updatedUserTime; }
        public UserShortLink setUpdatedUserTime(Date value) { this.updatedUserTime = value; return this; }
        public Long getTsid() { return tsid; }
        public UserShortLink setTsid(Long value) { this.tsid = value; return this; }
        public String getGroup() { return group; }
        public UserShortLink setGroup(String value) { this.group = value; return this; }
        public String getUsername() { return username; }
        public UserShortLink setUsername(String value) { this.username = value; return this; }
        public String getJsonMetadata() { return jsonMetadata; }
        public UserShortLink setJsonMetadata(String value) { this.jsonMetadata = value; return this; }
        public String getJsonItemMetadata() { return jsonItemMetadata; }
        public UserShortLink setJsonItemMetadata(String value) { this.jsonItemMetadata = value; return this; }
        public String getJsonPostProcessingRules() { return jsonPostProcessingRules; }
        public UserShortLink setJsonPostProcessingRules(String value) { this.jsonPostProcessingRules = value; return this; }
        public String getJsonOverrides() { return jsonOverrides; }
        public UserShortLink setJsonOverrides(String value) { this.jsonOverrides = value; return this; }
        public BigDecimal getTotalClicks() { return totalClicks; }
        public UserShortLink setTotalClicks(BigDecimal value) { this.totalClicks = value; return this; }
        public String getAdvertiser() { return advertiser; }
        public UserShortLink setAdvertiser(String value) { this.advertiser = value; return this; }
        public Long getAdvertiserId() { return advertiserId; }
        public UserShortLink setAdvertiserId(Long value) { this.advertiserId = value; return this; }
        public BigDecimal getPercentChangePeriodOverPeriod() { return percentChangePeriodOverPeriod; }
        public UserShortLink setPercentChangePeriodOverPeriod(BigDecimal value) { this.percentChangePeriodOverPeriod = value; return this; }
        public BigDecimal getPreviousPeriodTotalClicks() { return previousPeriodTotalClicks; }
        public UserShortLink setPreviousPeriodTotalClicks(BigDecimal value) { this.previousPeriodTotalClicks = value; return this; }
        public Long getIsArchived() { return isArchived; }
        public UserShortLink setIsArchived(Long value) { this.isArchived = value; return this; }
        public Integer getIsArchivedInt() { return isArchivedInt; }
        public UserShortLink setIsArchivedInt(Integer value) { this.isArchivedInt = value; return this; }
        public Boolean isFetchMetadata() { return fetchMetadata; }
        public UserShortLink setFetchMetadata(Boolean value) { this.fetchMetadata = value; return this; }
        public String getProductDisplayName1() { return productDisplayName1; }
        public UserShortLink setProductDisplayName1(String value) { this.productDisplayName1 = value; return this; }
        public String getProductDisplayName2() { return productDisplayName2; }
        public UserShortLink setProductDisplayName2(String value) { this.productDisplayName2 = value; return this; }
        public String getProductDisplayName3() { return productDisplayName3; }
        public UserShortLink setProductDisplayName3(String value) { this.productDisplayName3 = value; return this; }
        public String getProductArtworkThumbnailUrl() { return productArtworkThumbnailUrl; }
        public UserShortLink setProductArtworkThumbnailUrl(String value) { this.productArtworkThumbnailUrl = value; return this; }
        public String getProductArtworkThumbnailUrl100() { return productArtworkThumbnailUrl100; }
        public UserShortLink setProductArtworkThumbnailUrl100(String value) { this.productArtworkThumbnailUrl100 = value; return this; }
        public String getAdvertiserIcon() { return advertiserIcon; }
        public UserShortLink setAdvertiserIcon(String value) { this.advertiserIcon = value; return this; }
        public String getAdvertiserIconCssClass() { return advertiserIconCssClass; }
        public UserShortLink setAdvertiserIconCssClass(String value) { this.advertiserIconCssClass = value; return this; }
        public Boolean getIsGenius() { return isGenius; }
        public UserShortLink setIsGenius(Boolean value) { this.isGenius = value; return this; }
        public String getAdvertiserIconTitle() { return advertiserIconTitle; }
        public UserShortLink setAdvertiserIconTitle(String value) { this.advertiserIconTitle = value; return this; }
        public String getTrackingPixelIds() { return trackingPixelIds; }
        public UserShortLink setTrackingPixelIds(String value) { this.trackingPixelIds = value; return this; }
        public Long getApplePreference() { return applePreference; }
        public UserShortLink setApplePreference(Long value) { this.applePreference = value; return this; }
        public ArrayList<ShortUrlAlias> getAliases() { return aliases; }
        public UserShortLink setAliases(ArrayList<ShortUrlAlias> value) { this.aliases = value; return this; }
        public LinkCreatorOption getLinkCreatorSetting() { return linkCreatorSetting; }
        public UserShortLink setLinkCreatorSetting(LinkCreatorOption value) { this.linkCreatorSetting = value; return this; }
    }

    @DataContract
    public static class ShortUrlAlias implements IShortUrlAlias
    {
        @DataMember
        public String code = null;

        @DataMember
        public String domain = null;

        @DataMember
        public String baseCode = null;

        @DataMember
        public Date lastUpdatedUtc = null;
        
        public String getCode() { return code; }
        public ShortUrlAlias setCode(String value) { this.code = value; return this; }
        public String getDomain() { return domain; }
        public ShortUrlAlias setDomain(String value) { this.domain = value; return this; }
        public String getBaseCode() { return baseCode; }
        public ShortUrlAlias setBaseCode(String value) { this.baseCode = value; return this; }
        public Date getLastUpdatedUtc() { return lastUpdatedUtc; }
        public ShortUrlAlias setLastUpdatedUtc(Date value) { this.lastUpdatedUtc = value; return this; }
    }

    public static enum LinkCreatorOption
    {
        NotSet,
        Simple,
        Split,
        Advanced,
        Interstitial,
        Other;
    }

}

Java 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
		}
	]
}