V3 REFERENCE Statistics

/listrecipientstatistics

View statistics on Messages sent to the recipients of a given list.

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

# list listrecipientstatistics resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/listrecipientstatistics
Properties
Name Description
BlockedCount Number of blocked messages.
  • Read Only
  • [ Type Int64 ]
BouncedCount Number of bounced messages.
  • Read Only
  • [ Type Int64 ]
ClickedCount Number of registered clicks.
  • Read Only
  • [ Type Int64 ]
Data Extra data associated with contact. This is only present when ShowExtraData filter is 1.
  • Read Only
  • [ Type TKeyValueList ]
DeliveredCount Number of messages delivered to their destination.
  • Read Only
  • [ Type Int64 ]
LastActivityAt Timestamp of last registered activity for this contact.
  • Read Only
  • [ Type TRFC3339DateTime ]
ListRecipientID ID reference to ListRecipient Listrecipient for which the statistics are shown.
  • Read Only
  • [ Type TListRecipient ]
OpenedCount Number of message open registrations.
  • Read Only
  • [ Type Int64 ]
ProcessedCount Total number of messages processed by Mailjet.
  • Read Only
  • [ Type Int64 ]
QueuedCount Number of messages waiting in send queue.
  • Read Only
  • [ Type Int64 ]
SpamComplaintCount Number of spam complaints.
  • Read Only
  • [ Type Int64 ]
UnsubscribedCount Number of unsubscribed contacts
  • Read Only
  • [ Type Int64 ]
Filters
Name Description
Blocked Only retrieve ListRecipient that have blocked messages.
  • [ Type TBooleanFilter ]
Bounced Only retrieve ListRecipient that have bounced messages.
  • [ Type TBooleanFilter ]
Click Only retrieve ListRecipient that have clicks registered for messages.
  • [ Type TBooleanFilter ]
Contact Only retrieve ListRecipients for the indicated Contact ID.
  • [ Type Int64 ]
ContactsList Only retrieve ListRecipients for the indicated ContactsList ID.
  • [ Type Int64 ]
DateFormat
  • [ Type AnsiString ]
IsActive Only retrieve listrecipientstatistics resources for which ListRecipient.IsActive equals the specified value.
  • [ Type TBooleanFilter ]
IsExcludedFromCampaigns TBooleanFilter: Only retrieve listrecipientstatistics resources for which IsExcludedFromCampaigns equals the specified value.
  • [ Type TBooleanFilter ]
IsUnsubscribed Only retrieve listrecipientstatistics resources for which ListRecipient.IsUnsubscribed equals the specified value.
  • [ Type TBooleanFilter ]
LastActivityAt Only retrieve Contactstatistics resources for which LastActivityAt equals the specified value.
  • [ Type TRFC3339DateTime ]
MaxLastActivityAt Only retrieve ListRecipient that have LastActivityAt less than this value.
  • [ Type TRFC3339DateTime ]
MaxUnsubscribedAt Only retrieve listrecipientstatistics resources for which ListRecipient.UnsubscribedAt is strictly less than the specified value.
  • [ Type TRFC3339DateTime ]
MinLastActivityAt Only retrieve ListRecipient that have LastActivityAt larger than this value.
  • [ Type TRFC3339DateTime ]
MinUnsubscribedAt Only retrieve listrecipientstatistics resources for which ListRecipient.UnsubscribedAt is greater than or equal to the specified value.
  • [ Type TRFC3339DateTime ]
Open Only retrieve ListRecipient that have opens registered for messages.
  • [ Type TBooleanFilter ]
Queued Only retrieve ListRecipient that have queued messages.
  • [ Type TBooleanFilter ]
Sent Only retrieve ListRecipient that have sent messages.
  • [ Type TBooleanFilter ]
ShowExtraData Show extra data associated with contact. Default is not to show extra data.
  • [ Type TBooleanFilter ]
Spam Only retrieve ListRecipient that have spam complaints.
  • [ Type TBooleanFilter ]
TimeZone
  • [ Type AnsiString ]
Unsubscribed Only retrieve ListRecipienttatistics resources for which Unsubscribed is nonzero.
  • [ Type TBooleanFilter ]

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

# access the listrecipientstatistics resource identified by $ID

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

    
    
Properties
Name Description
BlockedCount Number of blocked messages.
  • Read Only
  • [ Type Int64 ]
BouncedCount Number of bounced messages.
  • Read Only
  • [ Type Int64 ]
ClickedCount Number of registered clicks.
  • Read Only
  • [ Type Int64 ]
Data Extra data associated with contact. This is only present when ShowExtraData filter is 1.
  • Read Only
  • [ Type TKeyValueList ]
DeliveredCount Number of messages delivered to their destination.
  • Read Only
  • [ Type Int64 ]
LastActivityAt Timestamp of last registered activity for this contact.
  • Read Only
  • [ Type TRFC3339DateTime ]
ListRecipientID ID reference to ListRecipient Listrecipient for which the statistics are shown.
  • Read Only
  • [ Type TListRecipient ]
OpenedCount Number of message open registrations.
  • Read Only
  • [ Type Int64 ]
ProcessedCount Total number of messages processed by Mailjet.
  • Read Only
  • [ Type Int64 ]
QueuedCount Number of messages waiting in send queue.
  • Read Only
  • [ Type Int64 ]
SpamComplaintCount Number of spam complaints.
  • Read Only
  • [ Type Int64 ]
UnsubscribedCount Number of unsubscribed contacts
  • Read Only
  • [ Type Int64 ]