Queries
A query is a predefined, parameterized report identified by a slug. Running a query needs the business-insights:queries:execute scope.
GET /business-insights/acme/queries/points-leaders-bulletin?pageIndex=1&pageSize=25
Ocp-Apim-Subscription-Key: <key>
Authorization: Bearer <token>
Available queries
| Slug | Description |
|---|---|
backoffice-agent-licenses | Agent license details for back-office reporting. |
points-leaders-bulletin | Leaderboard of agents by points. |
recruits-leaders-bulletin | Leaderboard of agents by recruits. |
team-points-summary | Points summarized by team. |
An unknown slug returns 404.
Results
- Paged queries accept
pageIndex(default1) andpageSize(default50), and return the standard paged envelope. - Non-paged queries return a JSON array of rows.
Query parameters that aren't used for paging are passed to the query as parameters.