V3 REFERENCE Event API

/bouncestatistics

Statistics on the bounces generated by emails sent on a given API Key.

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

# list bouncestatistics resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/bouncestatistics
Properties
Name Description
BouncedAt Timestamp of bounce.
  • Read Only
  • [ Type TRFC3339DateTime ]
CampaignID
OR
CampaignALT
CampaignID
ID reference to Campaign
CampaignALT
Value of the CustomValue field of the related Campaign resource
  • Mandatory
  • Read Only
  • [ Type TCampaign ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Mandatory
  • Read Only
  • [ Type TContact ]
ID ID of the Message that led to this bounce.
  • Read Only
  • [ Type Int64 ]
IsBlocked Is contact blocked.
  • Read Only
  • [ Type Boolean ]
IsStatePermanent Is this a permanent bounce.
  • Read Only
  • [ Type Boolean ]
StateID ID reference to MessageState Current state of the message causing the bounce.
  • Read Only
  • [ Type TMessageState ]
Filters
Name Description
CampaignID Filter bounces on this campaign (ID).
  • [ Type Int64 ]
CampaignStatus Filter on campaign status.
  • [ Type SmallInt ]
ContactsList Filter bounces on this contact list (ID).
  • [ Type Int64 ]
CustomCampaign Filter bounces on this custom campaign value.
  • [ Type AnsiString ]
EventFromTs =Minimum value for BounceAt.
  • [ Type TRFC3339DateTime ]
EventToTs Maximum value for BounceAt
  • [ Type TRFC3339DateTime ]
From Filter results on from address.
  • [ Type AnsiString ]
FromDomain Filter results on from domain.
  • [ Type AnsiString ]
FromID Unique numerical ID for this object.
  • [ Type Int64 ]
FromTS Minimum value for campaign SendStartAt timestamp.
  • [ Type TRFC3339DateTime ]
FromType Type of from address.
  • [ Type LongInt ]
IsDeleted Filter on Campaign IsDeleted.
  • [ Type TBooleanFilter ]
IsNewsletterTool Filter on whether Campaign was started by the newsletter tool or not.
  • [ Type TBooleanFilter ]
IsStarred Filter on Campaign IsStarred.
  • [ Type TBooleanFilter ]
MessageStatus Filter on message status.
  • [ Type TMessageStatus ]
Period Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively.
  • [ Type AnsiString ]
ToTS Maximum value for campaign SendStartAt timestamp.
  • [ Type TRFC3339DateTime ]

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

# access the bouncestatistics resource identified by $ID

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

    
    
Properties
Name Description
BouncedAt Timestamp of bounce.
  • Read Only
  • [ Type TRFC3339DateTime ]
CampaignID
OR
CampaignALT
CampaignID
ID reference to Campaign
CampaignALT
Value of the CustomValue field of the related Campaign resource
  • Mandatory
  • Read Only
  • [ Type TCampaign ]
ContactID
OR
ContactALT
ContactID
ID reference to Contact
ContactALT
Value of the Email field of the related Contact resource
  • Mandatory
  • Read Only
  • [ Type TContact ]
ID ID of the Message that led to this bounce.
  • Read Only
  • [ Type Int64 ]
IsBlocked Is contact blocked.
  • Read Only
  • [ Type Boolean ]
IsStatePermanent Is this a permanent bounce.
  • Read Only
  • [ Type Boolean ]
StateID ID reference to MessageState Current state of the message causing the bounce.
  • Read Only
  • [ Type TMessageState ]