v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB
Sequences

Get sequence stats

Returns aggregated engagement metrics plus a live active/waiting enrollment breakdown by current node for a specific sequence. This is an alias for /metrics/sequences/{sequenceId}.

get/sequences/{sequenceId}/stats

Path parameters

sequenceIdstring required

Sequence ID

Query parameters

period'1h' | '24h' | '7d' | '30d' | '90d'

Sliding time window. Ignored when start and end are provided.

startstring date-time

Start of custom time range (ISO 8601). Must be used with end.

endstring date-time

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset open/click events.

Response

Success

successboolean
sequenceIdstring
periodstring

Echoed back when period is provided.

Example response

{
  "success": true,
  "sequenceId": "seq_abc123"
}