V3 REFERENCE Messages

/messagehistory

Event history of a message.

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

# list messagehistory resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/messagehistory
Properties
Name Description
Comment More details for the message
  • Read Only
  • [ Type AnsiString ]
EventAt Timestamp when event was registered.
  • Read Only
  • [ Type Int64 ]
EventType Type of event.
  • Read Only
  • [ Type TMessageEventType ]

Allowed values:
  • sent
  • opened
  • clicked
  • bounced
  • blocked
  • unsub
  • spam
State The state of the message
  • Read Only
  • [ Type AnsiString ]
Useragent Useragent used to trigger the event (when applicable).
  • Read Only
  • [ Type AnsiString ]
Filters
Name Description
Message ID of message for which to show the history.
  • [ Type Int64 ]

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

# access the messagehistory resource identified by $ID

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

    
    
Properties
Name Description
Comment More details for the message
  • Read Only
  • [ Type AnsiString ]
EventAt Timestamp when event was registered.
  • Read Only
  • [ Type Int64 ]
EventType Type of event.
  • Read Only
  • [ Type TMessageEventType ]

Allowed values:
  • sent
  • opened
  • clicked
  • bounced
  • blocked
  • unsub
  • spam
State The state of the message
  • Read Only
  • [ Type AnsiString ]
Useragent Useragent used to trigger the event (when applicable).
  • Read Only
  • [ Type AnsiString ]