← API Index
/api/stats/pushsummary1
Push notification sends aggregated per day and delivery channel: sends, failed, recipients, accepted, delivered, opened. Newest day first. Admin access or API-role account.
Parameters
| Name |
Description |
Type |
| days |
look back this many days (default 31, max 120 = retention) |
int |
| channel |
restrict to one delivery channel: onesignal, fcm or external |
string |
| type |
restrict to one push type, e.g. ORDER_REMINDER (see PushSend.type) |
string |
| oo-rf |
optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml |
String |
| oo-auth |
optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. |
int |
Error Responses
| HTTP Status |
Error Code |
Description |
| 403 |
not_auth |
Not authenticated, or neither admin access nor API role |
Response Types
| Type |
Version |
Description |
| PushDayStat |
1 |
Push sends of one day on one delivery channel, aggregated |
OpenAPI
See pushsummary1.yaml
Referenced in skills