V3 REFERENCE Statistics

/useragentstatistics

View statistics on User Agents. See total counts or filter per Campaign or Contacts List.API Key message Open/Click statistical data grouped per user agent (browser).

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

# list useragentstatistics resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/useragentstatistics
Properties
Name Description
Count Number of clicks using this browser.
  • Read Only
  • [ Type Int64 ]
DistinctCount User of messages clicked using this browser.
  • Read Only
  • [ Type Int64 ]
Platform Platform on which the browser runs.
  • Mandatory
  • Read Only
  • [ Type AnsiString ]
UserAgent Description of user agent.
  • Mandatory
  • Read Only
  • [ Type AnsiString ]
Filters
Name Description
CampaignID Unique numerical ID for this object.
  • [ Type Int64 ]
CampaignStatus Only retrieve campaigns for which Status equals the 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 ]
Event Event source. This is one of open or click.
  • [ Type AnsiString ]
ExcludePlatform Exclude browsers running on this platform from result.
  • [ 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 ]
Period Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively.
  • [ Type AnsiString ]
Platform Only retrieve useragentstatistics resources for which Platform equals the specified value.
  • [ Type AnsiString ]
ToTS Only retrieve campaigns with SendStartAt timestamp less than the specified value.
  • [ Type TRFC3339DateTime ]

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

# access the useragentstatistics resource identified by $ID

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

    
    
Properties
Name Description
Count Number of clicks using this browser.
  • Read Only
  • [ Type Int64 ]
DistinctCount User of messages clicked using this browser.
  • Read Only
  • [ Type Int64 ]
Platform Platform on which the browser runs.
  • Mandatory
  • Read Only
  • [ Type AnsiString ]
UserAgent Description of user agent.
  • Mandatory
  • Read Only
  • [ Type AnsiString ]