Returns all campaigns you have in your account by :status which is required. Also basic summary for each campaign including the ID. [Rate limited]

Request

There are three possible values of :status parameter:

  • sent - campaigns which are sent already
  • draft - campaigns which aren't completed or sent to subscribers
  • outbox - campaigns which are being sent right now or scheduled campaigns

If you do not specify :status parameter, it defaults to sent.

There are some optional parameters which are described above.

Response Body Parameters

ParameterTypeDescription
idIntegerID of a campaign
total_recipientsIntegerTotal count of receivers in campaign
typeStringPossible values:
regular
ab
followup
rss
date_createdStringWhen the campaign was created
date_sendStringWhen the email was sent. If campaign type is outbox, this parameter will show the scheduled date.
nameStringThe internal campaign name.
subjectStringThe subject of the email.
statusStringPossible values:

- sent
- draft
- outbox
openedObject
opened.countIntegerTotal opens of campaign.

Available only for sent campaigns.

Default value: 0
opened.rateFloatOpen rate of campaign.

Available only for sent campaigns.

Default value: 0
clickedObject
clicked.countIntegerTotal clicks of campaign.

Available only for sent campaigns.

Default value: 0
clicked.rateFloatClick rate of campaign.

Available only for sent campaigns.

Default value: 0

/campaigns/:status/count

You can retrieve only the number of campaigns by type. If you do not specify :status, it defaults to sent.

Response example

{
  "count": 3
}
Language
Authorization
Header
Click Try It! to start a request and see the response here!