Finding Values for Optional Filters

The following table that describes how to find values for each of the optional filters that may be supported for your statistic:

Optional Filter Expected Value

agent-id

The UUID of the resource (agent, supervisor, or administrator). Use the following route to retrieve a list of resources:

curl -X GET https://api.cxengage.net/v1/tenants/<tenantId>/users

For more information on making this request, see Users.
allocation

The resource's capacity status. Options include the following:

  • not-allocated
  • fully-allocated
  • allocated
channel-type

One of the following:

  • voice
  • sms
  • email
  • messaging
  • workItem
contact-id

The UUID of the contact. Use the following route to retrieve a list of contacts:

curl GET -H "Content-Type: application/json" https://api.cxengage.net/v1/tenants/<tenantId>/contacts

For more information on making this request, see Users.
contact-point The contact point where interaction is initiated. For example, your support email address, Facebook page ID, or phone number.
customer The customer contact information, such as a phone number, email address, or Facebook page ID.
direction Either inbound or outbound.
flow-id

The UUID of the flow. Use the following route to retrieve a list of flows:

curl -X GET https://api.cxengage.net/v1/ tenants/<tenantId>/flows

For more information on making this request, see Flows.
group-id

The group's unique identifier. Use the following CxEngage public REST API command to retrieve a list of groups.

curl -X GET https://api.cxengage.net/v1/tenants/{tenantID}/groups

For more information on making this request, see Groups.
interaction-id

The UUID of the interaction. Use the following route to retrieve a list of interactions:

curl GET https://api.cxengage.net/v1/tenants/<tenantId>/realtime-statistics/interactions

The response is limited to the first 50 completed interactions.

For more information on making this request, see Interaction Data.
queue-id

The UUID of the queue. Use the following route to retrieve a list of queues:

curl https://api.cxengage.net/v1/tenants/<tenantId>/queues

For more information on making this request, see Queues.
reason-id

The UUID of the presence reason. Use the following route to retrieve a list of presence reasons:

curl -X POST -H "Content-Type: application/json" https://api.cxengage.net/v1//tenants/<tenantId>/reason

For more information on making this request, see Presence Reasons.
reason-list-id

The UUID of the presence reason list. Use the following CxEngage public REST API command to retrieve a list of presence reason lists:

curl -X POST -H "Content-Type: application/json" https://api.cxengage.net/v1//tenants/<tenantId>/reasons-lists

For more information on making this request, see Presence Reason Lists.
skill-id

The UUID of the skill. Use the following CxEngage public REST API command to retrieve a list of skills:

curl -X GET https://api.cxengage.net/v1/tenants/{tenantID}/skills

For more information on making this request, see Skills.
state

The resource's state. Options include:

  • offline
  • idle
  • busy
  • away