V3 REFERENCE Messages

/messagesentstatistics

API Key Statistical campaign/message data. This endpoint will be deprecated as of 1st of july 2018. We advise to implement /statcounters endpoint instead.

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 RFC3339 DateTime ]
Blocked Indicates if the message has been blocked until now. Default = false.
  • Read Only
  • [ Type Boolean ]
Bounce Indicates if the message has been bounced until now. Default = false.
  • Read Only
  • [ Type Boolean ]
BounceDate Timestamp when the message had bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type RFC3339 DateTime ]
BounceReason The reaon why the message bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type String ]
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 Indicates if the message has been clicked until now. Default = false.
  • Read Only
  • [ Type Boolean ]
CntRecipients Number of recipients for this campaign.
  • Read Only
  • [ Type Integer ]
ComplaintDate Timestamp for the date of the complaint. Available if ShowExtraData=True.
  • Read Only
  • [ Type RFC3339 DateTime ]
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 String ]
FBLSource FBLSource. Available if ShowExtraData=True.
  • Read Only
  • [ Type String ]
MessageID Only retrieve statistics for the selected message.
  • Read Only
  • [ Type Integer ]
Open Indicates if the message has been opened until now. Default = false.
  • Read Only
  • [ Type Boolean ]
Queued Indicates if the message is still in queueing process. Default = false.
  • Read Only
  • [ Type Boolean ]
Sent Indicates if the message has been sent. Default = false.
  • Read Only
  • [ Type Boolean ]
Spam Indicates if a spam complaint has been registered for this message. Default = false.
  • Read Only
  • [ Type Boolean ]
StateID ID reference to MessageState Current state of the message.
  • Mandatory
  • Read Only
  • [ Type TMessageState ]
StatePermanent Indicates if an unsubscription has been registered for this message. Default = false.
  • Read Only
  • [ Type Boolean ]
Status Current status of the message.
  • Read Only
  • [ Type String ]
ToEmail The receiver email for the message
  • Read Only
  • [ Type String ]
Unsub Was there any unsubscribtion registered for that message? Default = false.
  • 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 Boolean ]
BounceEventFromTs Minimum value of BounceDate.
  • [ Type RFC3339 DateTime ]
BounceEventToTs Maximum value of BounceDate.
  • [ Type RFC3339 DateTime ]
CampaignID Unique numerical ID for this object.
  • [ Type Integer ]
Contact Only retrieve messagesentstatistics resources for which Contact equals the specified value.
  • [ Type Integer ]
ContactsList Only retrieve campaigns sent to specified Contacts list.
  • [ Type Integer ]
CustomCampaign Only retrieve campaigns with given Custom Value.
  • [ Type String ]
CustomID Returns messages tagged with a given CustomID
  • [ Type String ]
From Only retrieve campaigns with given From header.
  • [ Type String ]
FromDomain Only retrieve campaigns with given domain in From header.
  • [ Type String ]
FromID Only retrieve campaigns with this sender ID.
  • [ Type Integer ]
FromTS Only retrieve campaigns with SendStartAt after this timestamp.
  • [ Type RFC3339 DateTime ]
FromType Only retrieve campaigns with FromType equal to specified value.
  • [ Type Integer ]

Allowed values:
  • 1 = Transactional
  • 2 = Marketing
  • 3 = Unknown
IsDeleted Only retrieve campaigns where isDeleted matches the specified value.
  • [ Type Boolean ]
IsNewsletterTool Only retrieve campaigns which were started by the newsletter tool.
  • [ Type Boolean ]
IsStarred Only retrieve campaigns which were marked as starred.
  • [ Type Boolean ]
MessageStatus Only retrieve messages with Status equal to specified value.
  • [ Type String ]

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 ]
ProcessEmailAutomationRelations Indicates if Email has been processed through automation.
  • [ Type Boolean ]
RawData Works toghether with AllMessages. If both are True the method returns only the most important data to reduce database load.
  • [ Type Boolean ]
ShowExtraData Fills the values for BounceDate, BounceReason, FBLSource and ComplaintDate.
  • [ Type Boolean ]
SpamEventFromTs Maximum value of Complaintdate
  • [ Type RFC3339 DateTime ]
SpamEventToTs Maximum value of ComplaintDate
  • [ Type RFC3339 DateTime ]
ToTS Only retrieve campaigns with SendStartAt timestamp less than the specified value.
  • [ Type RFC3339 DateTime ]
WorkflowID Only retrieve messagesentstatistics resources for which WorkflowID equals the specified value.
  • [ Type Integer ]

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 RFC3339 DateTime ]
Blocked Indicates if the message has been blocked until now. Default = false.
  • Read Only
  • [ Type Boolean ]
Bounce Indicates if the message has been bounced until now. Default = false.
  • Read Only
  • [ Type Boolean ]
BounceDate Timestamp when the message had bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type RFC3339 DateTime ]
BounceReason The reaon why the message bounced. Available if ShowExtraData=True
  • Read Only
  • [ Type String ]
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 Indicates if the message has been clicked until now. Default = false.
  • Read Only
  • [ Type Boolean ]
CntRecipients Number of recipients for this campaign.
  • Read Only
  • [ Type Integer ]
ComplaintDate Timestamp for the date of the complaint. Available if ShowExtraData=True.
  • Read Only
  • [ Type RFC3339 DateTime ]
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 String ]
FBLSource FBLSource. Available if ShowExtraData=True.
  • Read Only
  • [ Type String ]
MessageID Only retrieve statistics for the selected message.
  • Read Only
  • [ Type Integer ]
Open Indicates if the message has been opened until now. Default = false.
  • Read Only
  • [ Type Boolean ]
Queued Indicates if the message is still in queueing process. Default = false.
  • Read Only
  • [ Type Boolean ]
Sent Indicates if the message has been sent. Default = false.
  • Read Only
  • [ Type Boolean ]
Spam Indicates if a spam complaint has been registered for this message. Default = false.
  • Read Only
  • [ Type Boolean ]
StateID ID reference to MessageState Current state of the message.
  • Mandatory
  • Read Only
  • [ Type TMessageState ]
StatePermanent Indicates if an unsubscription has been registered for this message. Default = false.
  • Read Only
  • [ Type Boolean ]
Status Current status of the message.
  • Read Only
  • [ Type String ]
ToEmail The receiver email for the message
  • Read Only
  • [ Type String ]
Unsub Was there any unsubscribtion registered for that message? Default = false.
  • Read Only
  • [ Type Boolean ]
Workflow Unique numerical ID for the workflow.
  • Read Only
  • [ Type TWorkflow ]