Clicks Event Report API

You can use this API to view the reports on clicks for a given time period or for a particular contact email.

Request Type

Request URL

https://campaigns.zoho.com/emailapi/v2/reports/event/click

Content Type

application/json

List of Request Body Attributes

Parameters	Data Type	Description
from	Long	Starting time (in UTC milliseconds) for the reports. Defaults to the starting time of the last 7 days if not provided.
to	Long	Ending time (in UTC milliseconds) for the reports. Defaults to the ending time of the last 7 days if not provided.
email	String	Email address for which the reports must be obtained.
start_index	Integer	Starting index of the number of objects to be obtained. Defaults to 1 if not provided.
end_index	Integer	Ending index of the number of objects to be obtained. Defaults to 100 if not provided.

List of Response Body Attributes

Parameters	Data Type	Description
data	JSON Array	Contains the details of the report.
action_time	Long	Time (in UTC milliseconds) at which the click event happened.
injected_time	Long	Time (in UTC milliseconds) at which the transmission* was created.
rcpt_additional_data	JSON Object	Additional data of the recipient that was provided by you in Transmission API or Recipient List API.
transmission_id	Integer	Unique, system generated ID of the transmission.
contact_id	Integer	Unique, system generated ID of the contact/recipient.
click_url	String	The link which was clicked by the contact.
transmission_name	String	Name of the transmission.
zuid	Integer	Zoho User ID of the user who created the transmission.
contact_email	String	Email address of the contact/recipient.
response	JSON Object	Contains the response details of the API.
code	Integer	Success or failure code.
message	String	Success or failure message returned by the API.
errors	JSON Array	Contains the error details of the API such as 'code' and 'message'.

* - transmission refers to a campaign

Possible Error Cases

Error Codes	Description
400301	Date range incorrect/not provided
400302	Invalid index parameter(s)
400303	Date range exceeds the allowed limit
400304	Invalid contact email

Run in Postman View Collection

Sample Request Payload

Copiedhttps://campaigns.zoho.com/emailapi/v2/reports/event/click?from=1733097600000&to=1735794302000

Sample Response - Success

Copied{
  "data": [
    {
      "action_time": 1733312508000,
      "injected_time": 1733312405000,
      "rcpt_additional_data": {
        "country": "India",
        "phone": "+911234567890",
        "id": 173333220452133
      },
      "transmission_id": 214512348000002400000,
      "contact_id": 21454811000002420000,
      "click_url": "https://zylker.com",
      "transmission_name": "API CAMPAIGN 1",
      "zuid": 841951234838,
      "contact_email": "john.doe@zylker.com"
    },
    {
      "action_time": 1734409307000,
      "injected_time": 1734409209000,
      "rcpt_additional_data": {
        "country": "India",
        "Phone": "+911234567890"
      },
      "transmission_id": 214548041200002430000,
      "contact_id": 21454811000002420000,
      "click_url": "https://zylker-alt.com",
      "transmission_name": "API CAMPAIGN 2",
      "zuid": 841951234838,
      "contact_email": "john.doe@zylker.com"
    }
  ],
  "response": {
    "code": 200301,
    "message": "Successfully obtained the reports for the given criteria"
  }
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 400301,
      "message": "Date range incorrect/not provided"
    }
  ]
}