Get method to list a Campaigns from account
| Name | Description |
|---|---|
| account_id required | Your account unique identifier to access API. |
| status | Search by: status possible values [draft, scheduled, inprogress, completed, ongoing, paused] |
| schedule_type | Search by: schedule_type possible values [now, scheduled, automation_trigger, automation_cron] |
| limit | limit of number campaigns returns, default: 200 |
| order | creation_date order asc or desc, default: desc |
GET
/v2/account/:account_id/campaigns/
Accept: application/json
Authorization: Token token={account.secret}
Content-Type: application/json
200{
"campaigns": [
{
"id": "61fb9d11d11520261bb5436c",
"name": "Cai_Im1",
"created_at": "2022-02-03T09:14:57.188Z",
"updated_at": "2022-02-03T09:26:46.953Z",
"description": "Cai_Im1",
"status": "completed",
"schedule_type": "now",
"time_zone": "Jakarta",
"send_date": "2022-02-03T09:19:06.330Z",
"filters": [
{
"id": "5e53ee3bf703664f9e000008",
"name": "dantoc"
}
],
"reports": {
"global": {
"totals": 5,
"sent": 0,
"delivered": 5,
"undelivered": 0,
"pending": 0,
"opened": 0,
"clicked": 0,
"unsubscribed": 0
},
"purchases": {
"total_purchases": 0,
"total_products": 0,
"total_contacts": 0,
"total_add_cart": 0,
"total_remove_cart": 0,
"total_product_view": 0,
"total_product_refund": 0,
"total_purchase_failed": 0
}
}
},
{
"id": "61fb9c65d11520261bb54344",
"name": "Cai_Im",
"created_at": "2022-02-03T09:12:05.906Z",
"updated_at": "2022-02-03T09:18:02.837Z",
"description": "Cai_Im",
"status": "completed",
"schedule_type": "now",
"time_zone": "Jakarta",
"send_date": "2022-02-03T09:12:11.596Z",
"filters": [
{
"id": "5e53ee3bf703664f9e000008",
"name": "dantoc"
}
],
"reports": {
"global": {
"totals": 5,
"sent": 0,
"delivered": 5,
"undelivered": 0,
"pending": 0,
"opened": 0,
"clicked": 0,
"unsubscribed": 0
},
"purchases": {
"total_purchases": 0,
"total_products": 0,
"total_contacts": 0,
"total_add_cart": 0,
"total_remove_cart": 0,
"total_product_view": 0,
"total_product_refund": 0,
"total_purchase_failed": 0
}
}
}
]
}