Endpoint: https://api.omnisend.com/v3/campaigns
Campaign statuses
| Status | Description |
|---|---|
| draft | Campaign saved as draft. |
| paused | Campaign is paused |
| scheduled | Campaign is scheduled |
| inProgress | Sending in progress |
| sent | Sending finished. |
Campaign types
| Type | Description |
|---|---|
| standart | Standart campaign |
| abTest | A/B test campaign. |
Parameters
| Parameter | Type | Description |
|---|---|---|
| campaignID | string | Campaign ID |
| name | string | Campaign name |
| status | string | Campaign status - see above for available statuses. |
| type | string | Campaign type. See above for available types. |
| fromName | string | From name for this campaign emails |
| subject | string | Campaign emails subject |
| createdAt | string (format: date-time) | Campaign creation date. ISO 8601 format. Example: 2017-06-30T17:00:00Z |
| updatedAt | string (format: date-time) | Campaign update date. ISO 8601 format. Example: 2017-06-30T17:00:00Z |
| startDate | string (format: date-time) | Campaign emails start sending date. ISO 8601 format. Example: 2017-06-30T17:00:00Z |
| endDate | string (format: date-time) | Campaign emails sending end date. ISO 8601 format. Example: 2017-06-30T17:00:00Z |
| sent | integer | Sent emails count |
| clicked | integer | Clicked links in emails count |
| bounced | integer | Bounced emails count |
| complained | integer | Complaints count |
| opened | integer | Open emails count |
| unsubscribed | integer | Unsubscribed contacts count |
| allSubscribers | boolean | If campaign sent to all subscribers - true. |
| lists | array | DEPRECATED. Array of list ID's, for which campaign was sent (or will be sent) |
| listID | string | DEPRECATED. List ID |
| segments | array | Array of segment ID's, for which campaign was sent (or will be sent) |
| segmentID | string | Segment ID |
| abTestWinner | integer | Array of abtest winner email attributes. Available only for abTest type campaigns. |
| abTest | object | Array of abtest variants email attributes. Available only for abTest type campaigns. |
| abTest.winner | boolean | True if this abTest variant email is winner. |
| byDevices | object | Object of campaign results sorted by receiver devices |
| opened | object | Object for opened email count by devices |
| mobile | integer | Opened email in mobile devices count |
| desktop | integer | Opened email in desktop devices count |
| tablet | integer | Opened email in tablet devices count |
| clicked | object | Object for clicked email links count by devices |
| mobile | integer | Clicked links in mobile devices count |
| desktop | integer | Clicked links in desktop devices count |
| tablet | integer | Clicked links in tablet devices count |