« Back to Documentation Overviewget_links
Section: Links
Version: 1.5.0
Get clicktracked links.
Conditions:
- messages / get_messages (optional) – Search only in given messages. Uses OR logic. If those params are not given search is performed in all messages on the account. Check IDs in conditions for detailed explanation.
- url (optional) – Use text operators to narrow down search results to specific URL addresses.
Parameters
|
---|
string | API_KEY |
object | array | messages | string | MESSAGE_ID | string | MESSAGE_ID |
| string | get_messages | get_messages conditions | object | url | |
|
Return Value
|
---|
object | LINK_ID | string | message | MESSAGE_ID | string | name | My product 1 | string | url | http://myhomepage.com?product=1 | integer | clicks | 16 |
|
Example Request JSON
[
"API_KEY",
{
"messages": [
"MESSAGE_ID",
"MESSAGE_ID"
],
"get_messages": "get_messages conditions",
"url": {
"OPERATOR": "value"
}
}
]
Example Response JSON
{
"LINK_ID": {
"message": "MESSAGE_ID",
"name": "My product 1",
"url": "http:\/\/myhomepage.com?product=1",
"clicks": 16
}
}
API-wide Errors
|
---|
API key verification failed
| API key verification failed |
API client IP not allowed
| API client IP not allowed |
Invalid params
| Attribute params must be reference to hash |