Analytics

Get sequence metrics

Changed on

Returns aggregated engagement metrics plus a live active/waiting enrollment breakdown by current node for a specific sequence (automation).

get/metrics/sequences/{sequenceId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/metrics/sequences/{sequenceId}
  • Auth
    HTTP bearer

Path parameters

sequenceIdstring required

Sequence (automation) 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

{
  "pausedEnrollments": {
    "total": 1,
    "byCurrentNode": [
      {
        "currentNodeId": "node_delay_2",
        "count": 1
      }
    ]
  }
}

Changes