Genesys

Genesys Journey API

Predictive Engagement, Customer Journey

GitHub OpenAPI

Operations 92

POST /api/v2/analytics/journeys/aggregates/query Query for journey aggregates #
POST /api/v2/analytics/journeys/aggregates/jobs Query for journey aggregates asynchronously #
GET /api/v2/analytics/journeys/aggregates/jobs/{jobId} Get status for async query for journey aggregates #
DELETE /api/v2/analytics/journeys/aggregates/jobs/{jobId} Delete/cancel an async request for journey aggregates #
GET /api/v2/analytics/journeys/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
GET /api/v2/externalcontacts/contacts/{contactId}/journey/segments Retrieve segment assignments by external contact ID. #
POST /api/v2/externalcontacts/contacts/{contactId}/journey/segments Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assign #
GET /api/v2/externalcontacts/contacts/{contactId}/journey/sessions Retrieve all sessions for a given external contact. #
GET /api/v2/journey/actionmaps/{actionMapId} Retrieve a single action map. #
DELETE /api/v2/journey/actionmaps/{actionMapId} Delete single action map. #
PATCH /api/v2/journey/actionmaps/{actionMapId} Update single action map. #
GET /api/v2/journey/actionmaps Retrieve all action maps. #
POST /api/v2/journey/actionmaps Create an action map. #
GET /api/v2/journey/actiontargets/{actionTargetId} Deprecated. Retrieve a single action target. #
PATCH /api/v2/journey/actiontargets/{actionTargetId} Deprecated. Update a single action target. #
GET /api/v2/journey/actiontargets Deprecated. Retrieve all action targets. #
GET /api/v2/journey/actiontemplates/{actionTemplateId} Retrieve a single action template. #
DELETE /api/v2/journey/actiontemplates/{actionTemplateId} Delete a single action template. #
PATCH /api/v2/journey/actiontemplates/{actionTemplateId} Update a single action template. #
GET /api/v2/journey/actiontemplates Retrieve all action templates. #
POST /api/v2/journey/actiontemplates Create a single action template. #
GET /api/v2/journey/actionmaps/estimates/jobs/{jobId} Deprecated. Get status of job. #
GET /api/v2/journey/actionmaps/estimates/jobs/{jobId}/results Deprecated. Get estimates from completed job. #
POST /api/v2/journey/actionmaps/estimates/jobs Deprecated. Query for estimates #
GET /api/v2/journey/sessions/{sessionId}/events Retrieve all events for a given session. #
GET /api/v2/journey/externalevents/schemas/coretypes/{coreTypeName} Get a core type from which all schemas are built #
GET /api/v2/journey/externalevents/schemas/coretypes Get the list of core types enabled for a specific namespace. #
GET /api/v2/journey/externalevents/configurations/{configId} Get an external events configuration #
DELETE /api/v2/journey/externalevents/configurations/{configId} Delete an external events configuration. #
PATCH /api/v2/journey/externalevents/configurations/{configId} Update an external events configuration. #
GET /api/v2/journey/externalevents/configurations Get all external event configurations. #
POST /api/v2/journey/externalevents/configurations Create an external events configuration. #
POST /api/v2/journey/externalevents/configurations/{configurationId}/events Create external events #
GET /api/v2/journey/externalevents/schemas/limits Get quantitative limits on schemas #
GET /api/v2/journey/externalevents/schemas/{schemaId} Get a schema #
PUT /api/v2/journey/externalevents/schemas/{schemaId} Update a schema #
DELETE /api/v2/journey/externalevents/schemas/{schemaId} Delete a schema #
GET /api/v2/journey/externalevents/schemas/{schemaId}/versions Get all versions of a External Events schema #
GET /api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId} Get a specific version of a schema #
GET /api/v2/journey/externalevents/schemas Get a list of schemas. #
POST /api/v2/journey/externalevents/schemas Create a schema #
POST /api/v2/journey/flows/paths/query Query for flow paths. #
GET /api/v2/journey/outcomes/{outcomeId} Deprecated. Retrieve a single outcome. #
DELETE /api/v2/journey/outcomes/{outcomeId} Deprecated. Delete an outcome. #
PATCH /api/v2/journey/outcomes/{outcomeId} Deprecated. Update an outcome. #
GET /api/v2/journey/outcomes Deprecated. Retrieve all outcomes. #
POST /api/v2/journey/outcomes Deprecated. Create an outcome. #
GET /api/v2/journey/sessions/{sessionId}/outcomescores Deprecated. Retrieve latest outcome score associated with a session for all outcomes. #
GET /api/v2/journey/outcomes/predictors/{predictorId} Deprecated. Retrieve a single outcome predictor. #
DELETE /api/v2/journey/outcomes/predictors/{predictorId} Deprecated. Delete an outcome predictor. #
GET /api/v2/journey/outcomes/predictors Deprecated. Retrieve all outcome predictors. #
POST /api/v2/journey/outcomes/predictors Deprecated. Create an outcome predictor. #
GET /api/v2/journey/segments/{segmentId} Retrieve a single segment. #
DELETE /api/v2/journey/segments/{segmentId} Delete a segment. #
PATCH /api/v2/journey/segments/{segmentId} Update a segment. #
GET /api/v2/journey/segments Retrieve all segments. #
POST /api/v2/journey/segments Create a segment. #
GET /api/v2/journey/sessions/{sessionId} Retrieve a single session. #
GET /api/v2/journey/views/{viewId} Get a Journey View by ID #
DELETE /api/v2/journey/views/{viewId} Delete a Journey View by ID #
GET /api/v2/journey/views/{viewId}/versions/{versionId} Get a Journey View by ID and version #
PUT /api/v2/journey/views/{viewId}/versions/{versionId} Update a Journey View by ID and version #
POST /api/v2/journey/views/{viewId}/versions Update a Journey View by ID #
GET /api/v2/journey/views Get a list of Journey Views #
POST /api/v2/journey/views Create a new Journey View #
GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId} Get a Chart by ID #
GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion} Get a Chart by ID and version #
GET /api/v2/journey/views/data/details Get details about the data available for journey queries including oldest and newest event dates #
POST /api/v2/journey/views/encodings/validate Validate whether an encoding exist for a label/value combination. #
GET /api/v2/journey/views/eventdefinitions/{eventDefinitionId} Get an Event Definition #
PUT /api/v2/journey/views/eventdefinitions/{eventDefinitionId} Update external event for journey views #
GET /api/v2/journey/views/eventdefinitions Get a list of Event Definitions #
PUT /api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate Activate external event for journey views #
GET /api/v2/journey/views/eventdefinitions/external/changes Get changes in external event definitions #
GET /api/v2/journey/views/eventdefinitions/external Get external events for journey views #
GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest Get the latest job of a journey view version. #
GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} Get the job for a journey view version. #
PATCH /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} Update the job for a journey view version. Only the status can be changed and only to Cancelled #
GET /api/v2/journey/views/jobs/me Get my jobs #
GET /api/v2/journey/views/jobs Get the jobs for an organization. #
POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs Submit a job request for a journey view version. #
GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId} Get the chart result associated with a journey view job. #
GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results Get the result of a job for a journey view version. #
GET /api/v2/journey/views/schedules Get the journey schedules for an organization. #
GET /api/v2/journey/views/{viewId}/schedules Get the Schedule for a JourneyView #
POST /api/v2/journey/views/{viewId}/schedules Add a new Schedule to a JourneyView #
PUT /api/v2/journey/views/{viewId}/schedules Update the Schedule for a JourneyView #
DELETE /api/v2/journey/views/{viewId}/schedules Delete the Schedule of a JourneyView #
POST /api/v2/journey/deployments/{deploymentId}/actionevent Sends an action event, which is used for changing the state of actions that have been offered to the user. #
POST /api/v2/journey/deployments/{deploymentId}/appevents Send a journey app event, used for tracking customer activity on an application. #
GET /api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping Send a ping. #
POST /api/v2/journey/deployments/{deploymentId}/webevents Send a journey web event, used for tracking customer activity on a website. #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-journey-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-journey-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-journey-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Agent Assistants Journey API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:
- name: Journey
  description: Predictive Engagement, Customer Journey
  externalDocs:
    description: Journey documentation
    url: https://developer.genesys.cloud/commdigital/digital/webmessaging/journey/journey-apis
paths:
  /api/v2/analytics/journeys/aggregates/query:
    post:
      tags:
      - Journey
      summary: Query for journey aggregates
      description: ''
      operationId: postAnalyticsJourneysAggregatesQuery
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: postAnalyticsJourneysAggregatesQuery
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JourneyAggregationQuery'
        description: query
        required: true
  /api/v2/analytics/journeys/aggregates/jobs:
    post:
      tags:
      - Journey
      summary: Query for journey aggregates asynchronously
      description: ''
      operationId: postAnalyticsJourneysAggregatesJobs
      responses:
        '202':
          description: Accepted - Running query asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: postAnalyticsJourneysAggregatesJobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JourneyAsyncAggregationQuery'
        description: query
        required: true
  /api/v2/analytics/journeys/aggregates/jobs/{jobId}:
    get:
      tags:
      - Journey
      summary: Get status for async query for journey aggregates
      description: ''
      operationId: getAnalyticsJourneysAggregatesJob
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncQueryStatus'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: getAnalyticsJourneysAggregatesJob
    delete:
      tags:
      - Journey
      summary: Delete/cancel an async request for journey aggregates
      description: ''
      operationId: deleteAnalyticsJourneysAggregatesJob
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: deleteAnalyticsJourneysAggregatesJob
  /api/v2/analytics/journeys/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Journey
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsJourneysAggregatesJobResults
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        schema:
          type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyAsyncAggregateQueryResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: You are not authorized to perform the requested action.
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
    

# --- truncated at 32 KB (891 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-journey-api-openapi.yml