try out ↗

← API Index


/api/stats/push1

Recent push notification sends, one row per delivery channel (onesignal, fcm, external), newest first. Admin access or API-role account. Delivered/opened counts only carry information when analytics_capable is non-zero.

Parameters

Name Description Type
days look back this many days (default 31, max 120 = retention) int
limit maximum number of rows (default 100, max 1000) 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
serieref restrict to the pushes of one message series int
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
PushSend 1 One push notification send per delivery channel: what was sent, to whom, and how far it got (accepted / delivered / opened)

OpenAPI

See push1.yaml

Referenced in skills