Removing journeySegmentScope as a dimension and groupBy for journey analytics api

Announcements
1

Description

Genesys Cloud is deprecating the use of the journeySegmentScope as a dimension and groupBy parameter in the Journey Analytics Public API endpoint:

  • POST /api/v2/analytics/journeys/aggregates/query

What is changing?

  • The journeySegmentScope dimension will no longer be available for query aggregation.
  • The journeySegmentScope parameter will no longer be supported in the groupBy clause.

Recommended Action

  • Review and update any API requests that use journeySegmentScope as a dimension or in the groupBy clause.
  • Modify queries to use alternative dimensions or groupBy parameters where applicable.
  • Test your API integrations before the deprecation date to ensure continued functionality.

Change Category

Infrastructure
API

Change Context

This deprecation is part of an upcoming Customer Segmentation initiative, requiring the removal of redundant parameters.

Change Impact

Requests that include journeySegmentScope as a dimension or in the groupBy clause will return errors after the deprecation date.

Existing API integrations using journeySegmentScope will need to be updated to prevent disruptions.

Date of Change

25 Apr 2025

Impacted APIs

POST /api/v2/analytics/journeys/aggregates/query

References

[PURE-5834]
[PURE-6541]