Get information about a tracking link of a mailing

1 min

GET

https://api.campaign.episerver.net/rest/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}

Get detailed information about a tracking link of a mailing, such as ID, URL or link occurrences in the text version.

Path Parameters

clientIdinteger<int64>required
Description
Client ID
Format
int64
trackingLinkIdinteger<int64>required
Description
Tracking link ID
Format
int64
transactionalMailIdinteger<int64>required
Description
Transactional mail ID
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Responses

200The tracking link was retrieved successfully.

RestTrackingLink
- idinteger<int64>
  Description
  Tracking link ID
  Format
  int64
- urlstring
  Description
  Tracking link URL
- htmlTrackingstring<DEFAULT | ENABLED | DISABLED>
  Description
  Tracking state of a link in the HTML version
  Allowed
  DEFAULTENABLEDDISABLED
- textTrackingstring<DEFAULT | ENABLED | DISABLED>
  Description
  Tracking state of a link in the text version
  Allowed
  DEFAULTENABLEDDISABLED
- descriptionstring
  Description
  Tracking link description
- htmlOccurrencesinteger<int32>
  Description
  Link occurrences in the HTML version
  Format
  int32
- textOccurrencesinteger<int32>
  Description
  Link occurrences in the text version
  Format
  int32
- clickProfileIdsinteger[]
  Description
  Click profile IDs
- linksobject[]
  Description
  Restful links
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri

curl

curl --request GET \
     --url https://api.campaign.episerver.net/rest/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId} \
     --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}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}", 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}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}")

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}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// The tracking link was retrieved successfully.
{
  "id": "",
  "url": "",
  "htmlTracking": "",
  "textTracking": "",
  "description": "",
  "htmlOccurrences": "",
  "textOccurrences": "",
  "clickProfileIds": [
    0
  ],
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ]
}