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 alreadydraft- campaigns which aren't completed or sent to subscribersoutbox- 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
Parameter | Type | Description |
|---|---|---|
id |
| ID of a campaign |
total_recipients |
| Total count of receivers in campaign |
type |
| Possible values:
|
date_created |
| When the campaign was created |
date_send |
| When the email was sent. If campaign type is |
name |
| The internal campaign name. |
subject |
| The subject of the email. |
status |
| Possible values:
|
opened |
| |
opened.count |
| Total opens of campaign. Available only for Default value: |
opened.rate |
| Open rate of campaign. Available only for Default value: |
clicked |
| |
clicked.count |
| Total clicks of campaign. Available only for Default value: |
clicked.rate |
| Click rate of campaign. Available only for Default value: |
/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
}