« Back to Documentation Overview

get_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
stringAPI_KEY
object
arraymessages
stringMESSAGE_ID
stringMESSAGE_ID
stringget_messagesget_messages conditions
objecturl
stringOPERATORvalue
Return Value
objectLINK_ID
stringmessageMESSAGE_ID
stringnameMy product 1
stringurlhttp://myhomepage.com?product=1
integerclicks16

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