V3 REFERENCE Event API

/openinformation

Retrieve information 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 RFC3339 DateTime ]
CampaignID Reference to Campaign in which message is sent.
  • Read Only
  • [ Type Integer ]
ContactID Reference to contact to which message was sent.
  • Read Only
  • [ Type Integer ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Integer ]
MessageID Unique numerical ID for this object.
  • Read Only
  • [ Type Integer ]
OpenedAt Timestamp of when then message was opened by the reader for the first time.
  • Read Only
  • [ Type RFC3339 DateTime ]
UserAgentFull Original User Agent String used to view this message.
  • Read Only
  • [ Type String ]
UserAgentID Reference to canonicalized User Agent based on UserAgentFull
  • Read Only
  • [ Type Integer ]
Filters
Name Description
CampaignID Unique numerical ID for this object.
  • [ Type Integer ]
ContactsList Only retrieve campaigns sent to specified Contacts list.
  • [ Type Integer ]
CustomCampaign Only retrieve campaigns with given Custom Value.
  • [ Type String ]
EventFromTS Unix timestamp format. Minimum value for the opening timestamp.
  • [ Type RFC3339 DateTime ]
EventToTS Unix timestamp format. Maximum value for opening timestamp.
  • [ Type RFC3339 DateTime ]
From Only retrieve campaigns with given From header.
  • [ Type String ]
FromTS Unix timestamp format. Only retrieve campaigns with sending of the messages after this timestamp.
  • [ Type RFC3339 DateTime ]
IsDeleted Only retrieve resources for which IsDeleted equals the specified value.
  • [ Type Boolean ]
MessageStatus Only retrieve messages with status equal to specified value.
  • [ Type Integer ]

Allowed values:
  • 0 (Processed)
  • 1 (Queued)
  • 2 (Sent)
  • 3 (Opened)
  • 4 (Clicked)
  • 5 (Bounce)
  • 6 (Spam)
  • 7 (Unsub)
  • 8 (Blocked)
  • 9 (SoftBounce)
  • 10 (HardBounce)
  • 11 (Deferred)
Period Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively.
  • [ Type String ]
ToTS Unix timestamp format. Only retrieve campaigns with sending of the messages timestamp less than the specified value.
  • [ Type RFC3339 DateTime ]

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 RFC3339 DateTime ]
CampaignID Reference to Campaign in which message is sent.
  • Read Only
  • [ Type Integer ]
ContactID Reference to contact to which message was sent.
  • Read Only
  • [ Type Integer ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Integer ]
MessageID Unique numerical ID for this object.
  • Read Only
  • [ Type Integer ]
OpenedAt Timestamp of when then message was opened by the reader for the first time.
  • Read Only
  • [ Type RFC3339 DateTime ]
UserAgentFull Original User Agent String used to view this message.
  • Read Only
  • [ Type String ]
UserAgentID Reference to canonicalized User Agent based on UserAgentFull
  • Read Only
  • [ Type Integer ]