This page provides you with information on how to manage your campaigns.
Index:
Read and search campaigns
Read and search campaigns statistics
Read and search campaigns events
Read and search campaigns
Use the following endpoint to search and read the campaigns you have created in your project.
Description | Read and search campaigns |
HTTP Method | GET |
URL | |
Headers | X-Tenant: Authorization: Bearer |
Rate limit | 60 requests per minute |
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
The paging and filters can be combined. Filtering: # Search by type https://api.midway.la/api/consumer/campaigns?type=automation # Search by state https://api.midway.la/api/consumer/campaigns?state=active # Search by ids[] https://api.midway.la/api/consumer/campaigns?ids[]=1&ids[]=2 # Search by creation dates. https://api.midway.la/api/consumer/campaigns?created_at_from=2026-01-01 00:00:00&created_at_to=2026-01-31 23:59:59 Paging: https://api.midway.la/api/consumer/campaigns?type=manual&state=sent&per_page=100&ids[]=1&ids[]=2 |
Read campaigns statistics
Use the following endpoint to read statistics from campaigns.
Description | Read statistics |
HTTP Method | GET |
URL | |
Headers | X-Tenant: Authorization: Bearer |
Rate limit | 60 requests per minute |
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
The paging and filters can be combined. Filtering: # Search by type https://api.midway.la/api/consumer/campaigns/statistics?type=automation # Search by state https://api.midway.la/api/consumer/campaigns/statistics?state=active # Search by ids[] https://api.midway.la/api/consumer/campaigns/statistics?ids[]=1&ids[]=2 # Search by granularity https://api.midway.la/api/consumer/campaigns/statistics?granularity=daily # Search by statistic dates. https://api.midway.la/api/consumer/campaigns/statistics?date_from=2026-07-01 00:00:00&date_to=2026-07-31 23:59:59 Paging: https://api.midway.la/api/consumer/campaigns/statistics?granularity=daily&date_from=2026-07-01 00:00:00&date_to=2026-07-31 23:59:59&ids[]=1 |
Read campaigns events
Use the following endpoint to read statistics from campaigns.
Description | Read statistics |
HTTP Method | GET |
URL | |
Headers | X-Tenant: Authorization: Bearer |
Rate limit | 60 requests per minute |
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example)
|
The paging and filters can be combined. Filtering: # Search by email[] https://api.midway.la/api/consumer/campaigns/events?email[][email protected] # Search by state https://api.midway.la/api/consumer/campaigns/events?state=active # Search by campaign_id[] https://api.midway.la/api/consumer/campaigns/events?campaign_id[]=1&campaign_id[]=2 # Search by channel[] https://api.midway.la/api/consumer/campaigns/events?channel[]=email # Search by type_event[] https://api.midway.la/api/consumer/campaigns/events?type_event[]=open # Search by events dates. https://api.midway.la/api/consumer/campaigns/events?date_from=2026-07-01 00:00:00&date_to=2026-07-31 23:59:59 Paging (cursor pagination)
|