Analytics API: Exporting Custom Metrics for Architect Flows via REST

NICE CXone API & Integrations
1
  • Region: AU1
  • SDK: genesyscloud-python 2.1.5
  • Terraform Provider: 1.15.2
  • Python: 3.9

Is it possible to retrieve granular step-level analytics for specific Architect flows using the standard analytics API? The goal is to automate reporting on drop-off rates at specific nodes without relying on UI exports.

Trying to fetch data by querying flow aggregates. The request returns 200 OK but the payload lacks the steps array or any node-specific metrics. Only aggregate flow data is present.

Payload snippet:

{
 "queryResult": {
 "total": 1,
 "offset": 0,
 "pageSize": 100
 },
 "entities": [
 {
 "id": "abc-123",
 "name": "Main_Menu",
 "contactCount": 150
 }
 ]
}

Documentation suggests groupBy parameter might help, but no valid values for step-level granularity are listed. Is this approach deprecated for detailed node analysis? Or is there a specific query parameter syntax required to drill down into flow steps? Need this for automated dashboarding in our CI pipeline.

1 Like