{ "opencollection": "1.0.0", "info": { "name": "ActiveCampaign SMS Broadcast Accounts Metrics API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "Api-Token", "value": "{{Api-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "ActiveCampaign Get All Broadcast Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/sms/broadcasts/metrics", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date for metrics (YYYY-MM-DD)" }, { "name": "end_date", "value": "", "type": "query", "description": "End date for metrics (YYYY-MM-DD)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns metrics for specified broadcast IDs" }, { "info": { "name": "ActiveCampaign Get Broadcast Snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/sms/broadcasts/metrics/snapshot", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date for snapshot (YYYY-MM-DD)" }, { "name": "end_date", "value": "", "type": "query", "description": "End date for snapshot (YYYY-MM-DD)" } ] }, "docs": "Returns snapshot data for all broadcasts" }, { "info": { "name": "ActiveCampaign Get Broadcast Snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/sms/broadcasts/metrics/snapshot", "body": { "type": "json", "data": "{}" } }, "docs": "Returns snapshot for specified broadcast IDs" }, { "info": { "name": "ActiveCampaign Get Broadcast Failure Details", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/sms/broadcasts/metrics/:broadcastId/failures", "params": [ { "name": "broadcastId", "value": "", "type": "path", "description": "Broadcast ID" }, { "name": "start_date", "value": "", "type": "query", "description": "Start date (YYYY-MM-DD)" }, { "name": "end_date", "value": "", "type": "query", "description": "End date (YYYY-MM-DD)" } ] }, "docs": "Returns grouping and counts of failures for the broadcast" }, { "info": { "name": "ActiveCampaign Export Broadcast Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/sms/broadcasts/export", "body": { "type": "json", "data": "{}" } }, "docs": "Export broadcast performance metrics as CSV" }, { "info": { "name": "ActiveCampaign Export Broadcast Recipients", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/sms/broadcasts/:broadcastId/recipients/export", "params": [ { "name": "broadcastId", "value": "", "type": "path", "description": "Broadcast ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export recipient data as CSV including full contact records" } ] } ], "bundled": true }