Get information about all tracking links of a mailing
1 min
GET
https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links
Path Parameters
- clientIdinteger<int64>requiredDescriptionFormatint64
- mailingIdinteger<int64>requiredDescriptionFormatint64
- campaignIdinteger<int64>requiredDescriptionFormatint64
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/jsonapplication/vnd.optivo.broadmail.v1+json
Responses
200
- RestTrackingLink[]
- idinteger<int64>DescriptionFormatint64
- urlstringDescription
- htmlTrackingstring<DEFAULT | ENABLED | DISABLED>DescriptionAllowedDEFAULTENABLEDDISABLED
- textTrackingstring<DEFAULT | ENABLED | DISABLED>DescriptionAllowedDEFAULTENABLEDDISABLED
- descriptionstringDescription
- htmlOccurrencesinteger<int32>DescriptionFormatint32
- textOccurrencesinteger<int32>DescriptionFormatint32
- clickProfileIdsinteger[]Description
- linksobject[]Description
- uriBuilderobject
- relsstring[]
- relstring
- typestring
- paramsmap<string, string>
- titlestring
- uristring<uri>Formaturi
400
curl
curl --request GET \
--url https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// The tracking links were retrieved successfully.
[
{
"id": "",
"url": "",
"htmlTracking": "",
"textTracking": "",
"description": "",
"htmlOccurrences": "",
"textOccurrences": "",
"clickProfileIds": [
0
],
"links": [
{
"uriBuilder": {},
"rels": [
""
],
"rel": "",
"type": "",
"params": "",
"title": "",
"uri": ""
}
]
}
]400
// The number of tracking links exceeded the maximum of 3000.