@@ -12,20 +12,22 @@ or listing available queues.
1212
1313### Inputs
1414
15- * ` name `
16- * The name (or partial name) of the routing queue(s) to search for. Wildcards ('* ') are supported for pattern matching (e.g., 'Support* ', '* Emergency', '* Sales* '). Use '* ' alone to retrieve all queues.
17- * ` pageNumber `
18- * The page number of the results to retrieve, starting from 1. Defaults to 1 if not specified. Used with 'pageSize' for navigating large result sets.
19- * ` pageSize `
20- * The maximum number of queues to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 500.
15+ - ` name `
16+ - The name (or partial name) of the routing queue(s) to search for. Wildcards ('\ * ') are supported for pattern matching (e.g., 'Support\ * ', '\ * Emergency', '\ * Sales\ * '). Use '\ * ' alone to retrieve all queues.
17+ - ` pageNumber `
18+ - The page number of the results to retrieve, starting from 1. Defaults to 1 if not specified. Used with 'pageSize' for navigating large result sets.
19+ - ` pageSize `
20+ - The maximum number of queues to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 500.
2121
2222### Security
2323
2424Required permission:
25- * ` routing:queue:view `
25+
26+ - ` routing:queue:view `
2627
2728Platform API endpoint used:
28- * [ ` GET /api/v2/routing/queues ` ] ( https://developer.genesys.cloud/routing/routing/#get-api-v2-routing-queues )
29+
30+ - [ ` GET /api/v2/routing/queues ` ] ( https://developer.genesys.cloud/routing/routing/#get-api-v2-routing-queues )
2931
3032## Query Queue Volumes
3133
@@ -36,22 +38,24 @@ dates. Useful for comparing workload across queues.
3638
3739### Inputs
3840
39- * ` queueIds `
40- * The IDs of the queues to filter conversations by. Max 300.
41- * ` startDate `
42- * The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
43- * ` endDate `
44- * The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
41+ - ` queueIds `
42+ - The IDs of the queues to filter conversations by. Max 300.
43+ - ` startDate `
44+ - The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
45+ - ` endDate `
46+ - The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
4547
4648### Security
4749
4850Required permission:
49- * ` analytics:conversationDetail:view `
51+
52+ - ` analytics:conversationDetail:view `
5053
5154Platform API endpoints used:
52- * [ ` POST /api/v2/analytics/conversations/details/jobs ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs )
53- * [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId} ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId- )
54- * [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId}/results ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results )
55+
56+ - [ ` POST /api/v2/analytics/conversations/details/jobs ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs )
57+ - [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId} ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId- )
58+ - [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId}/results ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results )
5559
5660## Sample Conversations By Queue
5761
@@ -60,22 +64,24 @@ representative sample of conversation IDs. Useful for reporting, investigation,
6064
6165### Inputs
6266
63- * ` queueId `
64- * The ID of the queue to filter conversations by.
65- * ` startDate `
66- * The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
67- * ` endDate `
68- * The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
67+ - ` queueId `
68+ - The ID of the queue to filter conversations by.
69+ - ` startDate `
70+ - The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
71+ - ` endDate `
72+ - The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
6973
7074### Security
7175
7276Required Permission:
73- * ` analytics:conversationDetail:view `
77+
78+ - ` analytics:conversationDetail:view `
7479
7580Platform API endpoints used:
76- * [ ` POST /api/v2/analytics/conversations/details/jobs ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs )
77- * [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId} ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId- )
78- * [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId}/results ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results )
81+
82+ - [ ` POST /api/v2/analytics/conversations/details/jobs ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs )
83+ - [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId} ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId- )
84+ - [ ` GET /api/v2/analytics/conversations/details/jobs/{jobId}/results ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results )
7985
8086## Voice Call Quality
8187
@@ -89,16 +95,18 @@ Read more [about MOS scores and how they're determined](https://developer.genesy
8995
9096### Inputs
9197
92- * ` conversationIds `
93- * A list of up to 100 conversation IDs to evaluate voice call quality for.
98+ - ` conversationIds `
99+ - A list of up to 100 conversation IDs to evaluate voice call quality for.
94100
95101### Security
96102
97103Required Permission:
98- * ` analytics:conversationDetail:view `
104+
105+ - ` analytics:conversationDetail:view `
99106
100107Platform API endpoint used:
101- * [ ` GET /api/v2/analytics/conversations/details ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details )
108+
109+ - [ ` GET /api/v2/analytics/conversations/details ` ] ( https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details )
102110
103111## Conversation Sentiment
104112
@@ -110,14 +118,16 @@ and an interpreted sentiment label.
110118
111119### Inputs
112120
113- * ` conversationIds `
114- * A list of up to 100 conversation IDs to retrieve sentiment for.
121+ - ` conversationIds `
122+ - A list of up to 100 conversation IDs to retrieve sentiment for.
115123
116124### Security
117125
118126Required Permissions:
119- * ` speechAndTextAnalytics:data:view `
120- * ` recording:recording:view `
127+
128+ - ` speechAndTextAnalytics:data:view `
129+ - ` recording:recording:view `
121130
122131Platform API endpoint used:
123- * [ GET /api/v2/speechandtextanalytics/conversations/{conversationId}] ( https://developer.genesys.cloud/analyticsdatamanagement/speechtextanalytics/#get-api-v2-speechandtextanalytics-conversations--conversationId- )
132+
133+ - [ GET /api/v2/speechandtextanalytics/conversations/{conversationId}] ( https://developer.genesys.cloud/analyticsdatamanagement/speechtextanalytics/#get-api-v2-speechandtextanalytics-conversations--conversationId- )
0 commit comments