Skip to content

Commit 2986eee

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent 44ce722 commit 2986eee

73 files changed

Lines changed: 2167 additions & 59 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.lastupdated‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2025-11-27T05:40:19
1+
2025-12-11T08:20:16

‎docs/gc_analytics.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
* [gc analytics agents](gc_analytics_agents.html) - /api/v2/analytics/agents
3636
* [gc analytics botflows](gc_analytics_botflows.html) - /api/v2/analytics/botflows
3737
* [gc analytics bots](gc_analytics_bots.html) - /api/v2/analytics/bots
38+
* [gc analytics casemanagement](gc_analytics_casemanagement.html) - /api/v2/analytics/casemanagement
3839
* [gc analytics conversations](gc_analytics_conversations.html) - /api/v2/analytics/conversations
3940
* [gc analytics dataextraction](gc_analytics_dataextraction.html) - /api/v2/analytics/dataextraction
4041
* [gc analytics dataretention](gc_analytics_dataretention.html) - /api/v2/analytics/dataretention

‎docs/gc_analytics_casemanagement.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## gc analytics casemanagement
2+
3+
/api/v2/analytics/casemanagement
4+
5+
### Synopsis
6+
7+
/api/v2/analytics/casemanagement
8+
9+
### Options
10+
11+
```
12+
-h, --help help for casemanagement
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--accesstoken string accessToken override
19+
--clientid string clientId override
20+
--clientsecret string clientSecret override
21+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
22+
-i, --indicateprogress Trace progress indicators to stderr
23+
--inputformat string Data input format. Supported formats: YAML, JSON
24+
--outputformat string Data output format. Supported formats: YAML, JSON
25+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
26+
--transform string Provide a Go template file for transforming output data
27+
--transformstr string Provide a Go template string for transforming output data
28+
```
29+
30+
### SEE ALSO
31+
32+
* [gc analytics](gc_analytics.html) - /api/v2/analytics
33+
* [gc analytics casemanagement aggregates](gc_analytics_casemanagement_aggregates.html) - /api/v2/analytics/casemanagement/aggregates
34+
35+

‎docs/gc_analytics_casemanagement_aggregates.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## gc analytics casemanagement aggregates
2+
3+
/api/v2/analytics/casemanagement/aggregates
4+
5+
### Synopsis
6+
7+
/api/v2/analytics/casemanagement/aggregates
8+
9+
### Options
10+
11+
```
12+
-h, --help help for aggregates
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--accesstoken string accessToken override
19+
--clientid string clientId override
20+
--clientsecret string clientSecret override
21+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
22+
-i, --indicateprogress Trace progress indicators to stderr
23+
--inputformat string Data input format. Supported formats: YAML, JSON
24+
--outputformat string Data output format. Supported formats: YAML, JSON
25+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
26+
--transform string Provide a Go template file for transforming output data
27+
--transformstr string Provide a Go template string for transforming output data
28+
```
29+
30+
### SEE ALSO
31+
32+
* [gc analytics casemanagement](gc_analytics_casemanagement.html) - /api/v2/analytics/casemanagement
33+
* [gc analytics casemanagement aggregates jobs](gc_analytics_casemanagement_aggregates_jobs.html) - /api/v2/analytics/casemanagement/aggregates/jobs
34+
* [gc analytics casemanagement aggregates query](gc_analytics_casemanagement_aggregates_query.html) - /api/v2/analytics/casemanagement/aggregates/query
35+
36+

‎docs/gc_analytics_casemanagement_aggregates_jobs.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## gc analytics casemanagement aggregates jobs
2+
3+
/api/v2/analytics/casemanagement/aggregates/jobs
4+
5+
### Synopsis
6+
7+
/api/v2/analytics/casemanagement/aggregates/jobs
8+
9+
### Options
10+
11+
```
12+
-h, --help help for jobs
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--accesstoken string accessToken override
19+
--clientid string clientId override
20+
--clientsecret string clientSecret override
21+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
22+
-i, --indicateprogress Trace progress indicators to stderr
23+
--inputformat string Data input format. Supported formats: YAML, JSON
24+
--outputformat string Data output format. Supported formats: YAML, JSON
25+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
26+
--transform string Provide a Go template file for transforming output data
27+
--transformstr string Provide a Go template string for transforming output data
28+
```
29+
30+
### SEE ALSO
31+
32+
* [gc analytics casemanagement aggregates](gc_analytics_casemanagement_aggregates.html) - /api/v2/analytics/casemanagement/aggregates
33+
* [gc analytics casemanagement aggregates jobs create](gc_analytics_casemanagement_aggregates_jobs_create.html) - Query for case management aggregates asynchronously
34+
* [gc analytics casemanagement aggregates jobs delete](gc_analytics_casemanagement_aggregates_jobs_delete.html) - Delete/cancel an async request for case management aggregates
35+
* [gc analytics casemanagement aggregates jobs get](gc_analytics_casemanagement_aggregates_jobs_get.html) - Get status for async query for case management aggregates
36+
* [gc analytics casemanagement aggregates jobs results](gc_analytics_casemanagement_aggregates_jobs_results.html) - /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results
37+
38+

‎docs/gc_analytics_casemanagement_aggregates_jobs_create.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## gc analytics casemanagement aggregates jobs create
2+
3+
Query for case management aggregates asynchronously
4+
5+
### Synopsis
6+
7+
Query for case management aggregates asynchronously
8+
9+
```
10+
gc analytics casemanagement aggregates jobs create [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-d, --directory string Directory path with files containing request bodies
17+
-f, --file string File name containing the JSON body
18+
-h, --help help for create
19+
-b, --printrequestbody Print the request body format of the API.
20+
```
21+
22+
### Options inherited from parent commands
23+
24+
```
25+
--accesstoken string accessToken override
26+
--clientid string clientId override
27+
--clientsecret string clientSecret override
28+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
29+
-i, --indicateprogress Trace progress indicators to stderr
30+
--inputformat string Data input format. Supported formats: YAML, JSON
31+
--outputformat string Data output format. Supported formats: YAML, JSON
32+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
33+
--transform string Provide a Go template file for transforming output data
34+
--transformstr string Provide a Go template string for transforming output data
35+
```
36+
37+
### SEE ALSO
38+
39+
* [gc analytics casemanagement aggregates jobs](gc_analytics_casemanagement_aggregates_jobs.html) - /api/v2/analytics/casemanagement/aggregates/jobs
40+
41+

‎docs/gc_analytics_casemanagement_aggregates_jobs_delete.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## gc analytics casemanagement aggregates jobs delete
2+
3+
Delete/cancel an async request for case management aggregates
4+
5+
### Synopsis
6+
7+
Delete/cancel an async request for case management aggregates
8+
9+
```
10+
gc analytics casemanagement aggregates jobs delete [jobId] [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for delete
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--accesstoken string accessToken override
23+
--clientid string clientId override
24+
--clientsecret string clientSecret override
25+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
26+
-i, --indicateprogress Trace progress indicators to stderr
27+
--inputformat string Data input format. Supported formats: YAML, JSON
28+
--outputformat string Data output format. Supported formats: YAML, JSON
29+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
30+
--transform string Provide a Go template file for transforming output data
31+
--transformstr string Provide a Go template string for transforming output data
32+
```
33+
34+
### SEE ALSO
35+
36+
* [gc analytics casemanagement aggregates jobs](gc_analytics_casemanagement_aggregates_jobs.html) - /api/v2/analytics/casemanagement/aggregates/jobs
37+
38+

‎docs/gc_analytics_casemanagement_aggregates_jobs_get.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## gc analytics casemanagement aggregates jobs get
2+
3+
Get status for async query for case management aggregates
4+
5+
### Synopsis
6+
7+
Get status for async query for case management aggregates
8+
9+
```
10+
gc analytics casemanagement aggregates jobs get [jobId] [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for get
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--accesstoken string accessToken override
23+
--clientid string clientId override
24+
--clientsecret string clientSecret override
25+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
26+
-i, --indicateprogress Trace progress indicators to stderr
27+
--inputformat string Data input format. Supported formats: YAML, JSON
28+
--outputformat string Data output format. Supported formats: YAML, JSON
29+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
30+
--transform string Provide a Go template file for transforming output data
31+
--transformstr string Provide a Go template string for transforming output data
32+
```
33+
34+
### SEE ALSO
35+
36+
* [gc analytics casemanagement aggregates jobs](gc_analytics_casemanagement_aggregates_jobs.html) - /api/v2/analytics/casemanagement/aggregates/jobs
37+
38+

‎docs/gc_analytics_casemanagement_aggregates_jobs_results.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## gc analytics casemanagement aggregates jobs results
2+
3+
/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results
4+
5+
### Synopsis
6+
7+
/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results
8+
9+
### Options
10+
11+
```
12+
-h, --help help for results
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--accesstoken string accessToken override
19+
--clientid string clientId override
20+
--clientsecret string clientSecret override
21+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
22+
-i, --indicateprogress Trace progress indicators to stderr
23+
--inputformat string Data input format. Supported formats: YAML, JSON
24+
--outputformat string Data output format. Supported formats: YAML, JSON
25+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
26+
--transform string Provide a Go template file for transforming output data
27+
--transformstr string Provide a Go template string for transforming output data
28+
```
29+
30+
### SEE ALSO
31+
32+
* [gc analytics casemanagement aggregates jobs](gc_analytics_casemanagement_aggregates_jobs.html) - /api/v2/analytics/casemanagement/aggregates/jobs
33+
* [gc analytics casemanagement aggregates jobs results list](gc_analytics_casemanagement_aggregates_jobs_results_list.html) - Fetch a page of results for an async case management query
34+
35+

‎docs/gc_analytics_casemanagement_aggregates_jobs_results_list.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## gc analytics casemanagement aggregates jobs results list
2+
3+
Fetch a page of results for an async case management query
4+
5+
### Synopsis
6+
7+
Fetch a page of results for an async case management query
8+
9+
```
10+
gc analytics casemanagement aggregates jobs results list [jobId] [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-a, --autopaginate Automatically paginate through the results stripping page information
17+
--cursor string Cursor token to retrieve next page
18+
--filtercondition string Filter list command output based on a given condition or regular expression
19+
-h, --help help for list
20+
-s, --stream Paginate and stream data as it is being processed leaving page information intact
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```
26+
--accesstoken string accessToken override
27+
--clientid string clientId override
28+
--clientsecret string clientSecret override
29+
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
30+
-i, --indicateprogress Trace progress indicators to stderr
31+
--inputformat string Data input format. Supported formats: YAML, JSON
32+
--outputformat string Data output format. Supported formats: YAML, JSON
33+
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
34+
--transform string Provide a Go template file for transforming output data
35+
--transformstr string Provide a Go template string for transforming output data
36+
```
37+
38+
### SEE ALSO
39+
40+
* [gc analytics casemanagement aggregates jobs results](gc_analytics_casemanagement_aggregates_jobs_results.html) - /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results
41+
42+

0 commit comments

Comments
 (0)