Get Campaign Report: Links

GET https://emailoctopus.com/api/1.6/campaigns/:campaignId/reports/links

Get information on the performance of links in the campaign.

Parameters
api_key (string)	Your API key.

200 (success) returns

data (array of structs)

Details of each link:

link (struct)

Details of the link:

url (string)	The URL of the link.
clicked_total (int)	The number of total clicks.
clicked_unique (object)	The number of unique clicks.

paging (struct/array)

If there is more data available, an object is returned in the following format:

next (string)

A link for the immediate next page of results.

If there is no more data to page, an empty array is returned.

Non-200 (error) returns

Details of the error:

code (string)	The error code.
message (string)	A description of the error.

Method-specific error codes
CAMPAIGN_NOT_FOUND	The campaign could not be found.
CAMPAIGN_NOT_SENT	The campaign does not have a status of 'SENT'.
CAMPAIGN_FEATURE_DISABLED	The campaign does not have link tracking enabled.

API-wide error codes
INVALID_PARAMETERS	Parameters are missing or invalid.
API_KEY_INVALID	Your API key is invalid.
UNAUTHORISED	You're not authorised to perform that action.
NOT_FOUND	The requested endpoint does not exist.
UNKNOWN	An unknown error has occurred.

Example request
/api/1.6/campaigns/00000000-0000-0000-0000-000000000000/reports/links?api_key=00000000-0000-0000-0000-000000000000

Example response

Example response
`{ "data": [ { "url": "https://example.com/promo-1", "clicked_total": 90, "clicked_unique": 73 }, { "url": "https://example.com/promo-2", "clicked_total": 0, "clicked_unique": 0 }, { "url": "https://example.com/promo-3", "clicked_total": 10, "clicked_unique": 4 } ], "paging": [] }`

                        
                            {
                                "data": [
                                    {
                                        "url": "https://example.com/promo-1",
                                        "clicked_total": 90,
                                        "clicked_unique": 73
                                    },
                                    {
                                        "url": "https://example.com/promo-2",
                                        "clicked_total": 0,
                                        "clicked_unique": 0
                                    },
                                    {
                                        "url": "https://example.com/promo-3",
                                        "clicked_total": 10,
                                        "clicked_unique": 4
                                    }
                                ],
                                "paging": []
                            }

Code sample copy
curl -X GET \ https://emailoctopus.com/api/1.6/campaigns/00000000-0000-0000-0000-000000000000/reports/links?api_key=00000000-0000-0000-0000-000000000000
$ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://emailoctopus.com/api/1.6/campaigns/00000000-0000-0000-0000-000000000000/reports/links?api_key=00000000-0000-0000-0000-000000000000'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); $result = curl_exec($ch); if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); } curl_close($ch);
import requests params = ( ('api_key', '00000000-0000-0000-0000-000000000000'), ) response = requests.get('https://emailoctopus.com/api/1.6/campaigns/00000000-0000-0000-0000-000000000000/reports/links', params=params)
var https = require('https'); var options = { hostname: 'emailoctopus.com', port: 443, path: '/api/1.6/campaigns/00000000-0000-0000-0000-000000000000/reports/links?api_key=00000000-0000-0000-0000-000000000000', method: 'GET', }; var req = https.request(options); req.end();
package main import ( "io/ioutil" "log" "net/http" ) func main() { client := &http.Client{} req, err := http.NewRequest("GET", "https://emailoctopus.com/api/1.6/campaigns/00000000-0000-0000-0000-000000000000/reports/links?api_key=00000000-0000-0000-0000-000000000000", nil) if err != nil { log.Fatal(err) } resp, err := client.Do(req) if err != nil { log.Fatal(err) } bodyText, err := ioutil.ReadAll(resp.Body) if err != nil { log.Fatal(err) } }