Skip to main content

GET /tracking/link/log

GET 

tracking/link/log

Retrieve the event logs for tracking link click events

Query Parameters

period_from string Required
example 2021-07-06T00:00:00.000Z

period_to string Required
example 2021-07-06T00:00:00.000Z

offset string
Number of items to skip before starting to return results

limit string
Maximum number of items to return per request

sort string
Example: -campaign_id (desc) or campaign_id (asc)

campaign_id string
Filter by campaign identifier (letters, numbers, dashes, or underscores)

subscriber_id string
Filter by subscriber identifier (letters, numbers, dashes, underscores, dots, or email addresses)

profile_id string
Filter results by profile identifier

Returns

  • dataarray
    • idstring
      Log entry ID
    • timestampstring
      When the link was clicked
    • campaign_idstring
      Campaign identifier (or omitted if none)
    • subscriber_idstring
      Subscriber identifier (or omitted if none)
    • ipstring
      Client IP address
    • countrystring
      Country code (ISO)
    • browserstring
      Browser name and version
    • devicestring
      Device type or model
    • typestring
      Type of the tracking link
    • custom_link_titlestring
      Custom title for the tracking link
    • paramsarray
      Additional parameters
    • processing_errorstring
      Processing error if any occurred
  • metaobject
    Pagination metadata for list responses
    • countinteger
      Total number of items available
    • offsetinteger
      Number of items skipped
    • limitinteger
      Maximum number of items returned per request
Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error