ReportOpen Method - GET

Description

Lists emails tracked as opened.

Request URL

api.mailjet.com/0.1/reportOpen

Code Sample

<?php
 
# Call
$response = $mj->reportOpen();
 
# Result
$opens = $response->opens;
$count = $reponse->cnt;

Parameters

campaign_id (Integer, optional)
Description: Filter on Mailjet's Campaign ID
from (String, optional)
Description: Filter on Sender email
from_domain (String, optional)
Description: Filter on Domain
from_type (Integer, optional)
Description: Filter on email type. [0]: all; [1]: transactional only; [2]: campaigns only
limit (Integer, optional)
Description: Limit amount of results you want
start (Integer, optional)
Description: Start offset
ts_from (Timestamp, optional)
Description: Beginning of the period
ts_to (Timestamp, optional)
Description: End of the period

Return

status (String)
Description: Status of the response
cnt (Integer)
Description: Amount of distinct opens tracked
opens (Array)
Description: List of opens
LabelTypeDescription
arrival_tsTimestampDate of sending
clientStringClient (Gmail, Outlook, ...)
email_idIntegerMailjet's email ID
from_emailStringSender address
from_idIntegerMailjet's Sender ID
from_nameStringSender name
idIntegerMailjet's open ID
opened_atTimestampDate of open
open_delayIntegerOpen delay
sendtime_endIntegerDate of last email sent
sendtime_startIntegerDate of first email sent
subjectStringEmail's subject
to_emailStringEmail address
to_idIntegerMailjet's contact ID
user_agent_idIntegerMailjet's user agent ID