ONonesignal

View journey stats

Changed on

Retrieve performance stats for a single journey: journey-level entry and exit counts, per-node counts keyed by node id, per-branch counts keyed by branch id, and channel delivery stats for message-sending nodes. The response carries no definition detail, so join it by id against the journey from View journey.

get/apps/{app_id}/journeys/{id}/stats

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/apps/{app_id}/journeys/{id}/stats
  • Auth
    none required

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

idstring required

UUID of the journey to retrieve stats for.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Response

200

idstring

UUID of the journey these stats belong to.

startedinteger

Users who entered the journey.

completedinteger

Users who reached the end of the journey normally.

exited_earlyinteger

Users who left the journey through an early exit rule.

nodesobject

Node stats keyed by node id. Includes every node in the graph, at any nesting depth.

branchesobject

Branch stats keyed by branch id. Empty for a journey with no branching nodes.

Changes