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:
|
||||||||
paging (struct/array) |
If there is more data available, an object is returned in the following format:
If there is no more data to page, an empty array is returned. |
Non-200 (error) returns | ||||
---|---|---|---|---|
Details 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 | |
---|---|
|
Code sample
|
|
---|---|
|