V3 REFERENCE Statistics

/geostatistics

Message click/open statistics grouped per country

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

# list geostatistics resources

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

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

Properties
Name Description
ClickedCount Number of registered clicks.
  • Read Only
  • [ Type Int64 ]
Country Country.
  • Unique
  • Read Only
  • [ Type AnsiString ]
OpenedCount Number of message open registrations.
  • 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 ]
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 ]
ToTS Only retrieve campaigns with SendStartAt timestamp less than the specified value.
  • [ Type TRFC3339DateTime ]

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

# access the geostatistics resource identified by $ID

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

    
# access the resource through the Country'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/geostatistics/$Country
    
    
Unique Key

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

Properties
Name Description
ClickedCount Number of registered clicks.
  • Read Only
  • [ Type Int64 ]
Country Country.
  • Unique
  • Read Only
  • [ Type AnsiString ]
OpenedCount Number of message open registrations.
  • Read Only
  • [ Type Int64 ]