V3 REFERENCE Statistics

/liststatistics

View Campaign/message/click statistics grouped by ContactsList.

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

# list liststatistics resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/liststatistics
Properties
Name Description
ActiveCount Number of active list members.
  • Read Only
  • [ Type Int64 ]
ActiveExcludedSubscriberCount Total number of active contacts excluded from campaigns.
  • Read Only
  • [ Type Int64 ]
ActiveUnsubscribedCount Number of registered unsubscribe requests. (only calculated when CalcActiveUnsub filter is active).
  • Read Only
  • [ Type Int64 ]
Address List address.
  • Read Only
  • [ Type AnsiString ]
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 ]
CreatedAt Timestamp when object was created in database.
  • Read Only
  • [ Type TRFC3339DateTime ]
DeliveredCount Number of messages delivered to their destination.
  • Read Only
  • [ Type Int64 ]
ExcludedSubscriberCount Total number of contacts excluded from campaigns.
  • Read Only
  • [ Type Int64 ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
IsDeleted Is the list Deleted or not ?.
  • Read Only
  • [ Type Boolean ]
LastActivityAt Timestamp of last registered activity for this contactlist.
  • Read Only
  • [ Type TRFC3339DateTime ]
Name List name.
  • Read Only
  • [ Type AnsiString ]
OpenedCount Number of message open registrations.
  • Read Only
  • [ Type Int64 ]
SpamComplaintCount Number of spam complaints.
  • Read Only
  • [ Type Int64 ]
SubscriberCount Number of subscribers.
  • Read Only
  • [ Type LongInt ]
UnsubscribedCount Number of unsubscription events recieved from recipients directly.
  • Read Only
  • [ Type Int64 ]
Filters
Name Description
Address Filter list address.
  • [ Type AnsiString ]
CalcActive Should the ActiveCount property be calculated?
  • [ Type TBooleanFilter ]
CalcActiveExcludedSubscriber Control the processing of the ActiveExcludedSubscriberCount property. Processed only when set to true.
  • [ Type TBooleanFilter ]
CalcActiveUnsub Should the ActiveUnsubscribedCount property be calculated?
  • [ Type TBooleanFilter ]
CalcExcludedSubscriber Control the processing of the ExcludedSubscriberCount property. Processed only when set to true.
  • [ Type TBooleanFilter ]
ContactsListID Only retrieve ListStatistics resources for the specified contact list.
  • [ Type Int64 ]
ExcludeID Unique numerical ID for this object.
  • [ Type Int64 ]
IsDeleted Only retrieve ListStatistics resources for which IsDeleted equals the specified value.
  • [ Type TBooleanFilter ]
Name Only retrieve ListStatistics resources for which Name equals the specified value. The query is case sensitive.
  • [ Type AnsiString ]
NameCI Only retrieve ListStatistics resources for which Name equals the specified value. The query is case insensitive.
  • [ Type AnsiString ]
NameLike Only retrieve ListStatistics resources for which Name equals the specified value. The query is case sensitive and matches the search query anywhere within the data.
  • [ Type AnsiString ]
NameLikeCI Only retrieve ListStatistics resources for which Name equals the specified value. The query is case insensitive and matches the search query anywhere within the data.
  • [ Type AnsiString ]

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

# access the liststatistics resource identified by $ID

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

    
    
Properties
Name Description
ActiveCount Number of active list members.
  • Read Only
  • [ Type Int64 ]
ActiveExcludedSubscriberCount Total number of active contacts excluded from campaigns.
  • Read Only
  • [ Type Int64 ]
ActiveUnsubscribedCount Number of registered unsubscribe requests. (only calculated when CalcActiveUnsub filter is active).
  • Read Only
  • [ Type Int64 ]
Address List address.
  • Read Only
  • [ Type AnsiString ]
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 ]
CreatedAt Timestamp when object was created in database.
  • Read Only
  • [ Type TRFC3339DateTime ]
DeliveredCount Number of messages delivered to their destination.
  • Read Only
  • [ Type Int64 ]
ExcludedSubscriberCount Total number of contacts excluded from campaigns.
  • Read Only
  • [ Type Int64 ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
IsDeleted Is the list Deleted or not ?.
  • Read Only
  • [ Type Boolean ]
LastActivityAt Timestamp of last registered activity for this contactlist.
  • Read Only
  • [ Type TRFC3339DateTime ]
Name List name.
  • Read Only
  • [ Type AnsiString ]
OpenedCount Number of message open registrations.
  • Read Only
  • [ Type Int64 ]
SpamComplaintCount Number of spam complaints.
  • Read Only
  • [ Type Int64 ]
SubscriberCount Number of subscribers.
  • Read Only
  • [ Type LongInt ]
UnsubscribedCount Number of unsubscription events recieved from recipients directly.
  • Read Only
  • [ Type Int64 ]