Tracking Links

Create tracking link

Creates a tracking link for a specific campaign mailing delivery

URL

/tracking_links

Method

POST

Data parameters

{
"tracking_link": {
"campaign_mailing_delivery_id": "string",
"target_url": "string"
}
}

Success response

Code: 200
Content:

{
"url": "string"
}

Fetch tracking links

Return a list of json data for all tracking links associated to a campaign mailing send or campaign mailing delivery.

URL

/tracking_links

Method

GET

Data parameters

One of the following id's is required.

{
"tracking_link": {
"campaign_mailing_send_id": "string",
"campaign_mailing_delivery_id": "string"
}
}

Optional:

order_by[attribute] Attribute to sort on. Default value is created_at.

order=[asc | desc] Direction to sort. Default value is descending.

Success response

Code: 200
Content:

{
"data" : [
{
"id": "string",
"type": "tracking_link",
"attributes": {
"target_url": "string",
"opened_at": "string",
"clicked": "integer",
"campaign_mailing_delivery_id": "string"
}
}
]
}