| GET | /v4/links/metadata |
|---|
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 GetLinkMetadataResponse:
data: Optional[UserShortLink] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetLinkMetadataRequest:
alias_domain: Optional[str] = None
alias_code: Optional[str] = None
Python GetLinkMetadataRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","updatedUtc":"0001-01-01T00:00:00.0000000","notes":"String","createdUserTime":"0001-01-01T00:00:00.0000000","updatedUserTime":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000"}],"linkCreatorSetting":"NotSet"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}