V3 REFERENCE Statistics

/contactstatistics

View message statistics for a given contact.

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

# list contactstatistics resources

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

In addition to the resource $ID, you can also use the unique key $Email to identify this resource. Please refer to the field(s) description below for more information.

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 ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Read Only
  • [ Type TContact ]
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 ]
MarketingContacts Number of marketing contacts
  • Read Only
  • [ Type Int64 ]
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 registered unsubscribes
  • Read Only
  • [ Type Int64 ]
UserMarketingContacts Number of marketing contacts
  • Read Only
  • [ Type Int64 ]
Filters
Name Description
Blocked Only retrieve contacts that have blocked messages.
  • [ Type TBooleanFilter ]
Bounced Only retrieve contacts that have bounced messages.
  • [ Type TBooleanFilter ]
Click Only retrieve contacts that have clicks registered for messages.
  • [ Type TBooleanFilter ]
LastActivityAt Only retrieve Contactstatistics resources for which LastActivityAt equals the specified value.
  • [ Type TRFC3339DateTime ]
MaxLastActivityAt Only retrieve contacts that have LastActivityAt less than this value.
  • [ Type TRFC3339DateTime ]
MinLastActivityAt Only retrieve contacts that have LastActivityAt larger than this value.
  • [ Type TRFC3339DateTime ]
Open Only retrieve contacts that have opens registered for messages.
  • [ Type TBooleanFilter ]
Queued Only retrieve contacts that have queued messages.
  • [ Type TBooleanFilter ]
Recalculate Reload all data from the database
  • [ Type TBooleanFilter ]
Sent Only retrieve contacts that have sent messages.
  • [ Type TBooleanFilter ]
Spam Only retrieve contacts that have spam complaints.
  • [ Type TBooleanFilter ]
Unsubscribed Only retrieve contactstatistics resources for which Unsubscribed is nonzero.
  • [ Type TBooleanFilter ]

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

# access the contactstatistics resource identified by $ID

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

    
# access the resource through the Email's value
# note: all keys marked as 'unique' may be used as an alternate ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactstatistics/$Email
    
    
Unique Key

In addition to the resource $ID, you can also use the unique key $Email to identify this resource. Please refer to the field(s) description below for more information.

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 ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Read Only
  • [ Type TContact ]
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 ]
MarketingContacts Number of marketing contacts
  • Read Only
  • [ Type Int64 ]
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 registered unsubscribes
  • Read Only
  • [ Type Int64 ]
UserMarketingContacts Number of marketing contacts
  • Read Only
  • [ Type Int64 ]