Opens Event Report API

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

Request Type

Request URL

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

Content Type

application/json

List of Request Body Attributes

Parameters	Data Type	Description
from	Long	Starting time for the reports. Defaults to the starting time of the last 7 days if not provided.
to	Long	Ending time 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 at which the open event happened.
injected_time	Long	Time 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.
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/open?from=1733097600000&to=1735794302000

Sample Response - Success

Copied{
  "data": [
    {
      "action_time": 1733312488000,
      "injected_time": 1733312405000,
      "rcpt_additional_data": {
        "country": "India",
        "phone": "+911234567890",
        "id": 173333220452133
      },
      "transmission_id": 2411118000002420000,
      "contact_id": 2145124510002420000,
      "transmission_name": "API CAMPAIGN 1",
      "zuid": 8125123412838,
      "contact_email": "john.doe@zylker.com"
    },
    {
      "action_time": 1734409254000,
      "injected_time": 1734409209000,
      "rcpt_additional_data": {
        "country": "India",
        "Phone": "+911234567890"
      },
      "transmission_id": 2411128000002420000,
      "contact_id": 2145124510002420000,
      "transmission_name": "API CAMPAIGN 2",
      "zuid": 8125123412838,
      "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"
    }
  ]
}

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor

Workplace

Vani

Expense

Recruit

People