ShortlinksAPI

<back to all web services

GetShortLinksMetadataRequest

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShortUrlAlias(IShortUrlAlias):
    code: Optional[str] = None
    domain: Optional[str] = None
    base_code: Optional[str] = None
    last_updated_utc: datetime.datetime = datetime.datetime(1, 1, 1)


class LinkCreatorOption(str, Enum):
    NOT_SET = 'NotSet'
    SIMPLE = 'Simple'
    SPLIT = 'Split'
    ADVANCED = 'Advanced'
    INTERSTITIAL = 'Interstitial'
    OTHER = 'Other'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserShortLink(IUserShortLink):
    id: int = 0
    destination_url: Optional[str] = None
    short_url_code: Optional[str] = None
    domain: Optional[str] = None
    link_type: Optional[str] = None
    has_override: bool = False
    product_url: Optional[str] = None
    tracking_code: Optional[str] = None
    skip_affiliate_redirect: bool = False
    created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    notes: Optional[str] = None
    created_user_time: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_user_time: datetime.datetime = datetime.datetime(1, 1, 1)
    tsid: Optional[int] = None
    group: Optional[str] = None
    username: Optional[str] = None
    json_metadata: Optional[str] = None
    json_item_metadata: Optional[str] = None
    json_post_processing_rules: Optional[str] = None
    json_overrides: Optional[str] = None
    total_clicks: Decimal = decimal.Decimal(0)
    advertiser: Optional[str] = None
    advertiser_id: int = 0
    percent_change_period_over_period: Decimal = decimal.Decimal(0)
    previous_period_total_clicks: Decimal = decimal.Decimal(0)
    is_archived: int = 0
    is_archived_int: int = 0
    fetch_metadata: bool = False
    product_display_name1: Optional[str] = None
    product_display_name2: Optional[str] = None
    product_display_name3: Optional[str] = None
    product_artwork_thumbnail_url: Optional[str] = None
    product_artwork_thumbnail_url100: Optional[str] = None
    advertiser_icon: Optional[str] = None
    advertiser_icon_css_class: Optional[str] = None
    is_genius: bool = False
    advertiser_icon_title: Optional[str] = None
    tracking_pixel_ids: Optional[str] = None
    apple_preference: int = 0
    aliases: Optional[List[ShortUrlAlias]] = None
    link_creator_setting: Optional[LinkCreatorOption] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetShortLinksMetadataResponse(IGetShortLinksMetadataResponse):
    response_status: Optional[ResponseStatus] = None
    data: Optional[List[UserShortLink]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetShortLinksMetadataRequest(IGetShortLinksMetadataRequest):
    ids: Optional[List[str]] = None

Python GetShortLinksMetadataRequest DTOs

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