V3 REFERENCE Campaigns

/campaigngraphstatistics

API Campaign statistics grouped over intervals

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

# list campaigngraphstatistics resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigngraphstatistics
Properties
Name Description
Clickcount number of clicks
  • Read Only
  • [ Type Int64 ]
ID Unique ID of the object
  • Read Only
  • [ Type Int64 ]
Opencount Number of opened messaged
  • Read Only
  • [ Type Int64 ]
Spamcount Number of spam reports
  • Read Only
  • [ Type Int64 ]
Tick The resolution for the statistics. Start of campaign=0, steps of 15 or 30 mins
  • Read Only
  • [ Type Int64 ]
Unsubcount Number of unsubscribed contacts
  • Read Only
  • [ Type Int64 ]
Filters
Name Description
Click When != 0 returns stats in ClickedCount
  • [ Type TBooleanFilter ]
IDS Retrieve statistics only for the specified IDs
  • [ Type AnsiString ]
Open When != 0 returns stats in OpenedCount
  • [ Type TBooleanFilter ]
Range 24h or 7d. Period = 15 mins for 24h and 30 mins for 7d
  • [ Type AnsiString ]
Spam When != 0 returns stats in SpamCount
  • [ Type TBooleanFilter ]
Unsub When != 0 returns stats in UnsubCount
  • [ Type TBooleanFilter ]

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

# access the campaigngraphstatistics resource identified by $ID

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

    
    
Properties
Name Description
Clickcount number of clicks
  • Read Only
  • [ Type Int64 ]
ID Unique ID of the object
  • Read Only
  • [ Type Int64 ]
Opencount Number of opened messaged
  • Read Only
  • [ Type Int64 ]
Spamcount Number of spam reports
  • Read Only
  • [ Type Int64 ]
Tick The resolution for the statistics. Start of campaign=0, steps of 15 or 30 mins
  • Read Only
  • [ Type Int64 ]
Unsubcount Number of unsubscribed contacts
  • Read Only
  • [ Type Int64 ]