Search Journeys

post

{protocol}://{server}/api/journey/v1beta/accounts/{accountId}/journeys:search

This API requires the Agent role.

Searches for Customer Journeys using unique identifier(s) and optionally a time range can be provided. It is also possible to narrow the search down to a particular conversation and only return the parts of the Customer's Journey that contain it.

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. It will also include all the currently associated Identifiers with the Customer’s Journey.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

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

Query Params

pageSize

int32

1 to 50

Defaults to 50

The maximum number of results per page.

pageNumber

int32

≥ 1

Defaults to 1

The target page of results.

Body Params

Search for Journeys

Unique Customer ids used during an Engagement.

identifiers

object

required

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

startDate

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.

endDate

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.

conversation

string | null

The conversation to filter by.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200OK

400Bad Request. accountId must be exactly 6 characters pageNumber must be greater than 0 pageSize must be between 1 and 50 Invalid input, 'Identifiers' must not be empty

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error