V3 REFERENCE Event API

/openinformation

Retrieve informations about messages opened at least once by their recipients.

List openinformation resources available for this apikey, use a GET request. Alternatively, you may want to add one or more filters.

# list openinformation resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/openinformation
Properties
Name Description
ArrivedAt Timestamp indicating when the message arrived.
  • Read Only
  • [ Type TRFC3339DateTime ]
CampaignID
OR
CampaignALT
CampaignID
ID reference to Campaign
CampaignALT
Value of the CustomValue field of the related Campaign resource
  • Mandatory
  • Read Only
  • [ Type TCampaign ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Mandatory
  • Read Only
  • [ Type TContact ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
MessageID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
OpenedAt Timestamp of when then message was opened by the reader for the first time.
  • Read Only
  • [ Type TRFC3339DateTime ]
UserAgent Reference to canonicalized User Agent based on UserAgentFull
  • Read Only
  • [ Type TUserAgent ]
UserAgentFull Original User Agent string used to view this message.
  • Read Only
  • [ Type AnsiString ]
Filters
Name Description
CampaignID Unique numerical ID for this object.
  • [ Type Int64 ]
CampaignStatus Only retrieve campaigns with status equal to specified value.
  • [ Type SmallInt ]
ContactsList Only retrieve campaigns sent to specified Contacts list.
  • [ Type Int64 ]
CustomCampaign Only retrieve campaigns with given Custom Value.
  • [ Type AnsiString ]
EventFromTs Minimum value for openAt
  • [ Type TRFC3339DateTime ]
EventToTs Maximum value for openAt
  • [ Type TRFC3339DateTime ]
From Only retrieve campaigns with given From header.
  • [ Type AnsiString ]
FromDomain Only retrieve campaigns with given domain in From header.
  • [ Type AnsiString ]
FromID Only retrieve campaigns with this sender ID.
  • [ Type Int64 ]
FromTS Only retrieve campaigns with SendStartAt after this timestamp.
  • [ Type TRFC3339DateTime ]
FromType Only retrieve campaigns with FromType equal to specified value.
  • [ Type LongInt ]
IsDeleted Only retrieve campaigns where isDeleted matches the specified value.
  • [ Type TBooleanFilter ]
IsNewsletterTool Only retrieve campaigns which were started by the newsletter tool.
  • [ Type TBooleanFilter ]
IsStarred Only retrieve campaigns which were marked as starred.
  • [ Type TBooleanFilter ]
MessageStatus Only retrieve messages with status equal to specified value.
  • [ Type TMessageStatus ]
Period Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively.
  • [ Type AnsiString ]
ToTS Only retrieve campaigns with SendStartAt timestamp less than the specified value.
  • [ Type TRFC3339DateTime ]

Access a given openinformation resource, use a GET request, providing the openinformation's ID value.

# access the openinformation resource identified by $ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/openinformation/$ID

    
    
Properties
Name Description
ArrivedAt Timestamp indicating when the message arrived.
  • Read Only
  • [ Type TRFC3339DateTime ]
CampaignID
OR
CampaignALT
CampaignID
ID reference to Campaign
CampaignALT
Value of the CustomValue field of the related Campaign resource
  • Mandatory
  • Read Only
  • [ Type TCampaign ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Mandatory
  • Read Only
  • [ Type TContact ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
MessageID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
OpenedAt Timestamp of when then message was opened by the reader for the first time.
  • Read Only
  • [ Type TRFC3339DateTime ]
UserAgent Reference to canonicalized User Agent based on UserAgentFull
  • Read Only
  • [ Type TUserAgent ]
UserAgentFull Original User Agent string used to view this message.
  • Read Only
  • [ Type AnsiString ]