V3 REFERENCE Statistics

/graphstatistics

API Campaign/message/click statistics grouped over intervals.

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

# list graphstatistics resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/graphstatistics
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 ]
DeliveredCount Number of messages delivered to their destination.
  • 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 ]
RefTimestamp Reference time in textual form.
  • Read Only
  • [ Type AnsiString ]
SendtimeStart Minimum timestamp in the requested period.
  • Read Only
  • [ Type Int64 ]
SpamcomplaintCount Number of spam complaints.
  • Read Only
  • [ Type Int64 ]
UnsubscribedCount Number of registered unsubscribe requests.
  • Read Only
  • [ Type Int64 ]
Filters
Name Description
CampaignID Unique numerical ID for this object.
  • [ Type Int64 ]
CampaignStatus Only retrieve campaigns with status equal to specified value.
  • [ Type SmallInt ]
Contact Only retrieve campaigns sent to the specified contact.
  • [ Type LongInt ]
ContactsList Only retrieve campaigns sent to specified Contacts list.
  • [ Type Int64 ]
CustomCampaign Only retrieve campaigns with given Custom Value.
  • [ 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 TMessageStatus ]
Period Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively.
  • [ Type AnsiString ]
RefTimeStampOldFormat Enforce previous RefTimeStamp format
  • [ Type TBooleanFilter ]
Scale Scale for this statistic (hour, day, week, month, year)
  • [ Type AnsiString ]
TimeShift Time shift for the interval
  • [ Type TRFC3339DateTime ]
ToTS Only retrieve campaigns with SendStartAt timestamp less than the specified value.
  • [ Type TRFC3339DateTime ]
WorkflowID
  • [ Type Int64 ]

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

# access the graphstatistics resource identified by $ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/graphstatistics/$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 ]
DeliveredCount Number of messages delivered to their destination.
  • 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 ]
RefTimestamp Reference time in textual form.
  • Read Only
  • [ Type AnsiString ]
SendtimeStart Minimum timestamp in the requested period.
  • Read Only
  • [ Type Int64 ]
SpamcomplaintCount Number of spam complaints.
  • Read Only
  • [ Type Int64 ]
UnsubscribedCount Number of registered unsubscribe requests.
  • Read Only
  • [ Type Int64 ]