Search Journeys
POST https://{{axpAPIDomain}}/api/journey/v1/accounts/:accountId/journeys:search?pageSize=10&pageNumber=1
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | number | The maximum number of results per page. | |
pageNumber | number | The target page of results. |
Request Body
{"conversation"=>"Mortgage Application", "startDate"=>"2019-07-23T17:45:21.001Z", "endDate"=>"2020-07-23T17:45:21.001Z", "identifiers"=>{"emailAddresses"=>["melinda14@example.org"], "phoneNumbers"=>["019 718 0171", "+353 019 718 9999"]}, "agentId"=>"4dd8a4a4-09f4-4dab-a503-91cefc4604e0", "channelIds"=>["Voice", "Email"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"pagination":{"pageNumber":1,"pageSize":50,"total":2},"engagements":[{"id":"8e557fd6-580a-43b3-8cf9-db8169f4af5a","status":"COMPLETED","direction":"INBOUND","startDate":"2019-07-23T17:45:21.002Z","updateDate":"2019-07-23T17:47:21.002Z","endDate":"2019-07-23T17:50:21.002Z","channels":[{"id":"Voice","type":"VOICE"}],"identifiers":{"emailAddresses":["cmartin@example.org"],"phoneNumbers":["188-115-7717","+353 628 9848"]},"participants":[{"id":"443f413f-75f4-4ee4-a261-275e2c4a4c6f","joinedAt":"2019-07-23T17:45:21.002Z","leftAt":"2019-07-23T17:58:32.002Z","type":"EXTERNAL","channelId":"Voice","channelType":"VOICE","callingNumber":"087 12345","dialledNumber":"1590 12345","dialogId":"67ec5131-259c-4924-bb08-d87cf315e5e3"},{"id":"e5e8b989-c0d3-493e-9c6c-a1e482c42946","joinedAt":"2019-07-23T17:46:42.002Z","leftAt":"2019-07-23T18:00:32.002Z","type":"AGENT","channelId":"Voice","channelType":"VOICE","extension":"ext/1234","dialogId":"67ec5131-259c-4924-bb08-d87cf315e5e3"}],"conversations":["Mortgage Application","First-time Buyer"],"data":{"referenceNumber":"ref-4bf68d57-c189-4ad9-986f-e56ede9cdc32","currentStatus":"Under review"},"attributes":["Language.English","Support.Technical"],"queues":[{"queueId":"a12d14a2-99ad-4aed-8f55-5e87d18e9b9c","channelId":"Voice","priority":1,"rank":2147483647,"proficiencyRangeMin":4,"proficiencyRangeMax":10,"queuedAt":"2021-04-09T17:00:00.1Z","agentId":"93649e2e-f576-44b6-b002-fe61379cc4e5","acceptedAt":"2021-04-09T17:00:00.1Z"},{"queueId":"eae856cc-c4ff-4f44-a05a-b31ac0ed3278","channelId":"Voice","priority":1,"rank":2147483647,"proficiencyRangeMin":4,"proficiencyRangeMax":10,"queuedAt":"2021-04-09T17:00:00.1Z","agentId":"bef38a45-c61a-4abb-8106-f992ec4b4f22"}]},{"id":"94594028-5559-4efb-8263-9698e3ffe61d","status":"ACTIVE","direction":"OUTBOUND","startDate":"2019-07-23T17:45:21.002Z","channels":[{"id":"Voice","type":"VOICE"}],"identifiers":{"emailAddresses":["melinda14@example.org"],"phoneNumbers":["019 718 0171"]},"participants":[{"id":"443f413f-75f4-4ee4-a261-275e2c4a4c6f","joinedAt":"2019-07-23T17:45:21.002Z","leftAt":"2019-07-23T17:58:32.002Z","type":"EXTERNAL","channelId":"Voice","channelType":"VOICE","callingNumber":"087 12345","dialledNumber":"1590 12345","dialogId":"67ec5131-259c-4924-bb08-d87cf315e5e3"}],"conversations":["Mortgage Application"],"data":{"referenceNumber":"ref-4bf68d57-c189-4ad9-986f-e56ede9cdc32"}}],"identifiers":{"phoneNumbers":["019 718 0171","188-115-7717","+353 628 9848"],"emailAddresses":["melinda14@example.org","cmartin@example.org"],"universalIds":["7fdf89aa-70e6-4de9-8d7a-e1bbc4edcbaf"]}}