Journeys
Get journey run counts (Preview)
Preview · Available to selected organizations. Counts one published version's runs by status, and per node the live runs there now and the runs that have entered it. Defaults to the newest published version.
GET
Counts one published version's runs by status, and per node the live runs there now and the runs that have entered it. Defaults to the newest published version.
apiKeyheader
x-api-key<token>id*stringMatch
^jrny_[0-9a-hjkmnp-tv-z]{16,24}$version?|nullJourneyStats
application/json- response
journeyId*JourneyIdMatch
^jrny_[0-9a-hjkmnp-tv-z]{16,24}$version*integerRange
-9007199254740991 <= value <= 9007199254740991runs*nodes*array<>import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.journeys.stats({ "id": "example"});Example Response
{ "journeyId": "string", "version": -9007199254740991, "runs": { "active": -9007199254740991, "paused": -9007199254740991, "exited": -9007199254740991, "failed": -9007199254740991 }, "nodes": [ { "nodeId": "string", "current": -9007199254740991, "entered": -9007199254740991 } ]}Related documentation
Resume a journey (Preview)
Preview · Available to selected organizations. Resumes enrollment and continues the runs the pause held. Requires a plan that includes journeys.
Rename a journey (Preview)
Preview · Available to selected organizations. Renames a journey. Use this endpoint to rename a journey through the Samva email API.