List Agents
POST https://{{axpAPIDomain}}/api/journey/v1/accounts/:accountId/journeys:listAgents?pageSize=10&orderBy=asc
Lists the Agents to have participated on a Customer's Journey for the required Channel within a timeframe. By default this is limited to the last 30 days unless a startDate
for the search is provided.
The Agents are listed in descending order based on the leftAt
timefield, this can be changed to ascending with the optional orderBy
parameter.
This does not include any Agents that are currently active on the Customer's Journey that have yet to leave.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | number | The maximum number of results per page | |
orderBy | string | Ordering is performed on the "leftAt" field, the default order is descending. |
To specify ascending order, "asc" should be used. |
Request Body
{"identifiers"=>{"emailAddresses"=>["john@company.com"]}, "channelId"=>"Messaging"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
[{"agentId":"0f28895a-2855-4e02-b00c-52fe93d671f2","channelProviderId":"aba84546-1ac2-478e-b225-cadc7e8a2862","leftAt":"2020-07-26T13:24:52.130Z"},{"agentId":"c5e92685-921e-4dd3-b856-66b9fdadaca1","channelProviderId":"aba84546-1ac2-478e-b225-cadc7e8a2862","leftAt":"2020-07-23T18:12:34.246Z"},{"agentId":"faa542cb-1611-4ba5-a3db-1b6b1f560325","channelProviderId":"aba84546-1ac2-478e-b225-cadc7e8a2862","leftAt":"2020-07-19T10:45:22.589Z"}]