Skip to content
View as Markdown

GET Campaigns List​

GET
/reports/campaigns-list

Retrieve a paginated list of archived campaigns ordered by last update time. Each campaign in the response includes a computed stats object.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

per_page

Number of archived campaigns to return per page.

Type
integer
Default
15
page

Page number for pagination.

Type
integer
Default
1

Responses​

Archived campaigns retrieved successfully.

application/json
JSON
{
"campaigns": {
"current_page": 0,
"data": [
{
"id": 0,
"title": "string",
"status": "string",
"updated_at": "string",
"stats": {
"total": 0,
"sent": 0,
"clicks": 0,
"views": 0,
"unsubscribers": 0,
"revenue": {
"label": "string",
"total": "string",
"currency": "string"
}
}
}
],
"from": 0,
"last_page": 0,
"next_page_url": "string",
"path": "string",
"per_page": 0,
"prev_page_url": "string",
"to": 0,
"total": 0
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI