V3 REFERENCE Messages

/messagesentstatistics

API Key Statistical campaign/message data.

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

# list messagesentstatistics resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/messagesentstatistics
Properties
Name Description
ArrivalTs When did the message arrive at Mailjet.
  • Read Only
  • [ Type TRFC3339DateTime ]
Blocked Was the message blocked ?.
  • Read Only
  • [ Type Boolean ]
Bounce Has the message bounced ?.
  • Read Only
  • [ Type Boolean ]
BounceDate Timestamp when the message had bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type TRFC3339DateTime ]
BounceReason The reaon why the message bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type AnsiString ]
CampaignID
OR
CampaignALT
CampaignID
ID reference to Campaign
CampaignALT
Value of the CustomValue field of the related Campaign resource
  • Mandatory
  • Read Only
  • [ Type TCampaign ]
Click Was a click registered for this message ?.
  • Read Only
  • [ Type Boolean ]
CntRecipients Number of recipients for this campaign.
  • Read Only
  • [ Type Int64 ]
ComplaintDate Timestamp for the date of the complaint. Available if ShowExtraData=True
  • Read Only
  • [ Type TRFC3339DateTime ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Mandatory
  • Read Only
  • [ Type TContact ]
Details More details for the message
  • Read Only
  • [ Type AnsiString ]
FBLSource FBLSource. Available if ShowExtraData=True
  • Read Only
  • [ Type AnsiString ]
MessageID Only retrieve statistics for the selected message
  • Read Only
  • [ Type Int64 ]
Open Was the message opened ?.
  • Read Only
  • [ Type Boolean ]
Queued Is the message still in the queue ?.
  • Read Only
  • [ Type Boolean ]
Sent Was the message sent ?.
  • Read Only
  • [ Type Boolean ]
Spam Was a spam complaint registered for this message ?.
  • Read Only
  • [ Type Boolean ]
StateID ID reference to MessageState Current state of the message.
  • Mandatory
  • Read Only
  • [ Type TMessageState ]
StatePermanent Is the current state of the message permanent ?.
  • Read Only
  • [ Type Boolean ]
Status Current status of the message.
  • Read Only
  • [ Type AnsiString ]
ToEmail The receiver email for the message
  • Read Only
  • [ Type AnsiString ]
Unsub Was there unsubscribtion registered for that message?
  • Read Only
  • [ Type Boolean ]
Workflow Unique numerical ID for the workflow.
  • Read Only
  • [ Type TWorkflow ]
Filters
Name Description
AllMessages Retrieve all messages. Normally, only the first message of each campaign is retrieved.
  • [ Type TBooleanFilter ]
BounceEventFromTs Minimum value of BounceDate
  • [ Type TRFC3339DateTime ]
BounceEventToTs Maximum value of BounceDate
  • [ Type TRFC3339DateTime ]
CampaignID Unique numerical ID for this object.
  • [ Type Int64 ]
CampaignStatus Only retrieve campaigns with Status equal to specified value.
  • [ Type SmallInt ]
Contact Only retrieve messagesentstatistics resources for which Contact equals the specified value.
  • [ Type Int64 ]
ContactsList Only retrieve campaigns sent to specified Contacts list.
  • [ Type Int64 ]
CustomCampaign Only retrieve campaigns with given Custom Value.
  • [ Type AnsiString ]
CustomID Returns messages tagged with a given CustomID
  • [ Type AnsiString ]
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 AnsiString ]
Period Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively.
  • [ Type AnsiString ]
ProcessEmailAutomationRelations
  • [ Type TBooleanFilter ]
RawData Works toghether with AllMessages. If both are True the method returns only the most important data to reduce database load
  • [ Type TBooleanFilter ]
ShowExtraData Fills the values for BounceDate, BounceReason, FBLSource and ComplaintDate
  • [ Type TBooleanFilter ]
SpamEventFromTs Maximum value of Complaintdate
  • [ Type TRFC3339DateTime ]
SpamEventToTs Maximum value of ComplaintDate
  • [ Type TRFC3339DateTime ]
ToTS Only retrieve campaigns with SendStartAt timestamp less than the specified value.
  • [ Type TRFC3339DateTime ]
WorkflowID Only retrieve messagesentstatistics resources for which WorkflowID equals the specified value.
  • [ Type Int64 ]

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

# access the messagesentstatistics resource identified by $ID

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

    
    
Properties
Name Description
ArrivalTs When did the message arrive at Mailjet.
  • Read Only
  • [ Type TRFC3339DateTime ]
Blocked Was the message blocked ?.
  • Read Only
  • [ Type Boolean ]
Bounce Has the message bounced ?.
  • Read Only
  • [ Type Boolean ]
BounceDate Timestamp when the message had bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type TRFC3339DateTime ]
BounceReason The reaon why the message bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type AnsiString ]
CampaignID
OR
CampaignALT
CampaignID
ID reference to Campaign
CampaignALT
Value of the CustomValue field of the related Campaign resource
  • Mandatory
  • Read Only
  • [ Type TCampaign ]
Click Was a click registered for this message ?.
  • Read Only
  • [ Type Boolean ]
CntRecipients Number of recipients for this campaign.
  • Read Only
  • [ Type Int64 ]
ComplaintDate Timestamp for the date of the complaint. Available if ShowExtraData=True
  • Read Only
  • [ Type TRFC3339DateTime ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Mandatory
  • Read Only
  • [ Type TContact ]
Details More details for the message
  • Read Only
  • [ Type AnsiString ]
FBLSource FBLSource. Available if ShowExtraData=True
  • Read Only
  • [ Type AnsiString ]
MessageID Only retrieve statistics for the selected message
  • Read Only
  • [ Type Int64 ]
Open Was the message opened ?.
  • Read Only
  • [ Type Boolean ]
Queued Is the message still in the queue ?.
  • Read Only
  • [ Type Boolean ]
Sent Was the message sent ?.
  • Read Only
  • [ Type Boolean ]
Spam Was a spam complaint registered for this message ?.
  • Read Only
  • [ Type Boolean ]
StateID ID reference to MessageState Current state of the message.
  • Mandatory
  • Read Only
  • [ Type TMessageState ]
StatePermanent Is the current state of the message permanent ?.
  • Read Only
  • [ Type Boolean ]
Status Current status of the message.
  • Read Only
  • [ Type AnsiString ]
ToEmail The receiver email for the message
  • Read Only
  • [ Type AnsiString ]
Unsub Was there unsubscribtion registered for that message?
  • Read Only
  • [ Type Boolean ]
Workflow Unique numerical ID for the workflow.
  • Read Only
  • [ Type TWorkflow ]