| GET | /v4/links/metadata/{baseCode} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BaseCode | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Data | form | UserShortLink | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| DestinationUrl | form | string | No | |
| ShortUrlCode | form | string | No | |
| Domain | form | string | No | |
| LinkType | form | string | No | |
| HasOverride | form | bool | No | |
| ProductUrl | form | string | No | |
| TrackingCode | form | string | No | |
| SkipAffiliateRedirect | form | bool | No | |
| CreatedUtc | form | DateTime | No | |
| UpdatedUtc | form | DateTime | No | |
| Notes | form | string | No | |
| CreatedUserTime | form | DateTime | No | |
| UpdatedUserTime | form | DateTime | No | |
| Tsid | form | uint? | No | |
| Group | form | string | No | |
| Username | form | string | No | |
| JsonMetadata | form | string | No | |
| JsonItemMetadata | form | string | No | |
| JsonPostProcessingRules | form | string | No | |
| JsonOverrides | form | string | No | |
| TotalClicks | form | decimal | No | |
| Advertiser | form | string | No | |
| AdvertiserId | form | uint | No | |
| PercentChangePeriodOverPeriod | form | decimal | No | |
| PreviousPeriodTotalClicks | form | decimal | No | |
| IsArchived | form | uint | No | |
| IsArchivedInt | form | int | No | |
| FetchMetadata | form | bool | No | |
| ProductDisplayName1 | form | string | No | |
| ProductDisplayName2 | form | string | No | |
| ProductDisplayName3 | form | string | No | |
| ProductArtworkThumbnailUrl | form | string | No | |
| ProductArtworkThumbnailUrl100 | form | string | No | |
| AdvertiserIcon | form | string | No | |
| AdvertiserIconCssClass | form | string | No | |
| IsGenius | form | bool | No | |
| AdvertiserIconTitle | form | string | No | |
| TrackingPixelIds | form | string | No | |
| ApplePreference | form | uint | No | |
| Aliases | form | List<ShortUrlAlias> | No | |
| LinkCreatorSetting | form | LinkCreatorOption | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Domain | form | string | No | |
| BaseCode | form | string | No | |
| LastUpdatedUtc | form | DateTime | No |
| NotSet | |
| Simple | |
| Split | |
| Advanced | |
| Interstitial | |
| Other |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v4/links/metadata/{baseCode} HTTP/1.1
Host: shortlinks-api.qa.platform.georiot.com
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-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"}}