V3 REFERENCE Statistics

/toplinkclicked

Top links clicked historgram.

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

# list toplinkclicked resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/toplinkclicked
Properties
Name Description
ClickedCount Number of registered clicks.
  • Read Only
  • [ Type Int64 ]
LinkId Unique ID for the link.
  • Read Only
  • [ Type Int64 ]
Url Actual link clicked.
  • Read Only
  • [ Type AnsiString ]
Filters
Name Description
ActualClicks When true is specified the actual count of clicks instead the default de-duplicated count will be returned
  • [ Type TBooleanFilter ]
CampaignID Unique numerical ID for this object.
  • [ Type Int64 ]
CampaignStatus Only retrieve campaigns Status equals the specified value.
  • [ Type SmallInt ]
Contact Only retrieve messages to specified contact.
  • [ Type Int64 ]
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 ]
Message Only retrieve message corresponding to this ID.
  • [ Type Int64 ]
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 toplinkclicked resource, use a GET request, providing the toplinkclicked's ID value.

# access the toplinkclicked resource identified by $ID

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

    
    
Properties
Name Description
ClickedCount Number of registered clicks.
  • Read Only
  • [ Type Int64 ]
LinkId Unique ID for the link.
  • Read Only
  • [ Type Int64 ]
Url Actual link clicked.
  • Read Only
  • [ Type AnsiString ]