V3 REFERENCE Campaigns

/campaignoverview

Returns a list of campaigns, including the AX campaigns

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

# list campaignoverview resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaignoverview
Properties
Name Description
ClickedCount Clicked count
  • Read Only
  • [ Type Int64 ]
DeliveredCount Delivered (sent) count
  • Read Only
  • [ Type Int64 ]
EditMode Edit mode
  • Read Only
  • [ Type AnsiString ]
EditType Edit type
  • Read Only
  • [ Type AnsiString ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
IDType Campaign, AX campaign or newsletter
  • Read Only
  • [ Type AnsiString ]
OpenedCount Opened count
  • Read Only
  • [ Type Int64 ]
ProcessedCount How many items are processed
  • Read Only
  • [ Type Int64 ]
SendTimeStart Send time start
  • Read Only
  • [ Type Int64 ]
Starred Starred
  • Read Only
  • [ Type Boolean ]
Status Status of the campaign
  • Read Only
  • [ Type LongInt ]
Subject Subject of the campaign
  • Read Only
  • [ Type AnsiString ]
Title Title of the campaign
  • Read Only
  • [ Type AnsiString ]
Filters
Name Description
All Retrieve all campaigns that are not deleted
  • [ Type TBooleanFilter ]
Archived Only retrieve newsletter resources for which IsArchived equals the specified value and campaign
  • [ Type TBooleanFilter ]
Drafts Retrieve all campaigns that are in draft mode
  • [ Type TBooleanFilter ]
IDType Retrieve only campaignoverview resources for which IDType equals the specified value (AX, Campaign, NL or any combination of these 3)
  • [ Type AnsiString ]
Programmed Retrieve all programmed newsletters
  • [ Type TBooleanFilter ]
Sent Retrieve all sent campaigns
  • [ Type TBooleanFilter ]
Starred Only retrieve newsletters and campaigns with IsStarred equal to the specified value
  • [ Type TBooleanFilter ]
Subject Only retrieve newsletters and campaigns with this subject.
  • [ Type AnsiString ]

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

# access the campaignoverview resource identified by $ID

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

    
    
Properties
Name Description
ClickedCount Clicked count
  • Read Only
  • [ Type Int64 ]
DeliveredCount Delivered (sent) count
  • Read Only
  • [ Type Int64 ]
EditMode Edit mode
  • Read Only
  • [ Type AnsiString ]
EditType Edit type
  • Read Only
  • [ Type AnsiString ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
IDType Campaign, AX campaign or newsletter
  • Read Only
  • [ Type AnsiString ]
OpenedCount Opened count
  • Read Only
  • [ Type Int64 ]
ProcessedCount How many items are processed
  • Read Only
  • [ Type Int64 ]
SendTimeStart Send time start
  • Read Only
  • [ Type Int64 ]
Starred Starred
  • Read Only
  • [ Type Boolean ]
Status Status of the campaign
  • Read Only
  • [ Type LongInt ]
Subject Subject of the campaign
  • Read Only
  • [ Type AnsiString ]
Title Title of the campaign
  • Read Only
  • [ Type AnsiString ]