Explain routing priorities for a user
Explain the ticket routing considering the routing priorities. Useful when a user wants to know why they are being pushed a certain ticket.
The response format is controlled by limit:
-
limit=1(short format): returns{"details":[{"routingPriority":<int|string>,"id":<int>}]}.routingPriorityis an integer when the ticket will be routed to this user, or a localized human-readable string reason when it will not. An emptydetailsarray means the ticket is not in the routing queue (closed, AI-only, or non-existent). -
limit>1or default (full format): returns full routing metadata includingroutingPriority(ordered ticket IDs),details(all fields),total, andquery.
Permission: updateUserProfileSkills is required, EXCEPT for a single-ticket self-check —
limit=1 + numeric q (ticket id) + own profile — where the permission check is bypassed.
Autorisierungen
JWT-based authentication
Pfadparameter
The id of the profile to explain routing for
Abfrageparameter
If provided, explain routing relative to this ticket ID ("next" button). If omitted, explains routing for the earliest ticket.
Scope the explain query to a single ticket via an exact t.id match. Used by the FE
self-check on /ticket/{id}. Combined with limit=1 on your own profile this bypasses
the updateUserProfileSkills permission.
Full-text search filter across ticket id, contractId, customerId and fulltext fields.
Maximum number of tickets to return. Defaults to 500.
When set to 1, activates the short (stripped) response format.
1 <= x <= 500The number of items to skip
x >= 0Antwort
Successful operation
- Option 1
- Option 2
Short format response (limit=1). Contains only details array with routingPriority and id per element. No total or query fields.