Get Campaign list with stats
Request
Method | URL |
GET | https://api.ppcmate.com/adv/campaign |
Parameters
All fields are optional
Name | Value example | Description |
sortById | asc or desc | Sorting list by id |
page | 1 | Page number, if absent then value 1 will be used |
size | 10 | Page number, if absent then the maximum value will be used |
startDate | 2025-06-01 | Start date of stats period, set if you want to get stats |
endDate | 2025-06-21 | End date of stats period, set if you want to get stats |
Response
Status | Response |
200 | Response will be an object containing the list of campaigns. An example response is:- { "data": [ { "data": { "id": 52, "name": "Campaign #1", "lifeStatus": "Completed", "hold": false, "budgetRatio": 0.23, "totalBudget": 100, "startDate": "2024-09-26", "endDate": "2025-05-01", "campaignStats": { "campaignId": 52, "spends": 23.011, "impressions": 41838, "clicks": 0, "ctr": 0 } } }, { "data": { "id": 102, "name": "Campaign #2", "lifeStatus": "Running", "hold": true, "budgetRatio": 0, "totalBudget": 10, "startDate": "2024-11-27", "endDate": "2026-11-27" } } ], "pagination": { "size": 10, "currentPage": 1, "totalPages": 1, "total": 1 } } |
401 | { "timestamp": 1749101727160, "status": 401, "error": "Unauthorized", "path": "/adv/campaign" } |
Jun 6, 2025