Avaya Infinity™Avaya Experience Platform™
API Reference

Search Journeys

post
{protocol}://{server}{basePath}/accounts//journeys:search

This API requires the Agent role.

Searches for Customer Journeys optionally using different specific filters.

It makes it possible to narrow the search down to a particular conversation and only return the parts of the Customer's Journey that satisfies the given filter criteria.

The filter can include fields such as:

  • identifiers
  • channelIds
  • agentId
  • conversation
  • startDate & endDate

If found, the Customer's Journey will include a list of all the Engagements a Customer has had with the Contact Center, ordered by the startDate in descending order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6

The unique 6 character internal id that represents the customer account.

Query Params
int32
1 to 50
Defaults to 50

The maximum number of results per page.

int32
≥ 1
Defaults to 1

The target page of results.

Body Params

Search for Journeys

Unique Customer ids used during an Engagement.

identifiers
object

Unique identifiers for identifying the customer during an Engagement such as phoneNumbers or emailAddresses.

date-time | null

The start date in ISO 8601 format, for example 2018-11-13T20:20:39+00:00. The returned results will be inclusive of this datetime.

date-time | null

The end date in ISO 8601 format, for example 2018-11-13T20:20:39+00:00. The returned results will be inclusive of this datetime.

string | null

The conversation to filter by.

string
length between 3 and 36

The agent id to filter by.

channelIds
array of strings
length between 1 and 10

The list of channel Ids to filter by.

channelIds
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 5 months ago