@roarkanalytics/cli 0.60.0 → 0.61.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +13 -0
- package/commands.js +470 -0
- package/completions.js +4 -4
- package/man/roark-live-report-create.1 +135 -0
- package/man/roark-live-report-delete.1 +93 -0
- package/man/roark-live-report-document-get.1 +96 -0
- package/man/roark-live-report-document-list.1 +100 -0
- package/man/roark-live-report-get.1 +93 -0
- package/man/roark-live-report-list.1 +96 -0
- package/man/roark-live-report-run.1 +100 -0
- package/man/roark-live-report-update.1 +136 -0
- package/man/roark.1 +24 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +10 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-LIVE\-REPORT\-CREATE" "1" "" "roark-live-report-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-live\-report\-create \- Create a live report
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark live\-report create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Saves a report on the project's live calls. Simulations are never included. Targets are analytics measures held to a bar: a threshold metric is read as its pass rate (`value` is a percentage, 0\-100, held AT_LEAST by default); a numeric metric as its average (held AT_MOST by default). Every target is read for the period and the period before it, so the report says whether each was met and how it moved. Scheduled reports are written `deliveryHour` hours into the day after each period ends in `timezone` (a week runs Monday to Sunday), then emailed and posted per `notifications`. With `generateNow` (the default) the report for the latest closed period is written right away and not sent.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/live\-report
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
15
|
+
Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-description\fR \fI<value>\fR
|
|
18
|
+
Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-agent\-id\fR \fI<value>\fR
|
|
21
|
+
Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-filters\fR \fI<value>\fR
|
|
24
|
+
Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-targets\fR \fI<value>\fR
|
|
27
|
+
Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-dashboard\-id\fR \fI<value>\fR
|
|
30
|
+
Optional.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-cadence\fR \fI<value>\fR
|
|
33
|
+
One of: DAILY, WEEKLY, MONTHLY. Optional.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-timezone\fR \fI<value>\fR
|
|
36
|
+
Optional.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-delivery\-hour\fR \fI<value>\fR
|
|
39
|
+
Optional.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-status\fR \fI<value>\fR
|
|
42
|
+
One of: ACTIVE, PAUSED. Optional.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-\-notifications\fR \fI<value>\fR
|
|
45
|
+
Optional.
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-notifications.email\fR \fI<value>\fR
|
|
48
|
+
Required.
|
|
49
|
+
.TP
|
|
50
|
+
\fB\-\-notifications.slack\fR \fI<value>\fR
|
|
51
|
+
Required.
|
|
52
|
+
.TP
|
|
53
|
+
\fB\-\-include\-transcript\-excerpts\fR
|
|
54
|
+
Optional.
|
|
55
|
+
.TP
|
|
56
|
+
\fB\-\-generate\-now\fR
|
|
57
|
+
Write the report for the latest closed period right away. Default true. Optional.
|
|
58
|
+
.SH "GLOBAL OPTIONS"
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
61
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
64
|
+
Skip confirmation prompts.
|
|
65
|
+
.TP
|
|
66
|
+
\fB\-\-no\-input\fR
|
|
67
|
+
Never prompt; fail instead.
|
|
68
|
+
.TP
|
|
69
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
70
|
+
API base URL.
|
|
71
|
+
.TP
|
|
72
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
73
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
74
|
+
.TP
|
|
75
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
76
|
+
Request timeout in milliseconds.
|
|
77
|
+
.TP
|
|
78
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
79
|
+
Retries for retryable failures.
|
|
80
|
+
.TP
|
|
81
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
82
|
+
Output format: auto, json, jsonl, plain.
|
|
83
|
+
.TP
|
|
84
|
+
\fB\-\-json\fR
|
|
85
|
+
Shorthand for \-\-format json.
|
|
86
|
+
.TP
|
|
87
|
+
\fB\-\-no\-color\fR
|
|
88
|
+
Disable colour.
|
|
89
|
+
.TP
|
|
90
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
91
|
+
Suppress non\-essential output.
|
|
92
|
+
.TP
|
|
93
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
94
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
95
|
+
.SH "EXAMPLES"
|
|
96
|
+
.PP
|
|
97
|
+
.RS 4
|
|
98
|
+
.nf
|
|
99
|
+
roark live\-report create \-\-name <value> \-\-notifications.email <value> \-\-notifications.slack <value>
|
|
100
|
+
.fi
|
|
101
|
+
.RE
|
|
102
|
+
.SH "ENVIRONMENT"
|
|
103
|
+
.TP
|
|
104
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
105
|
+
Bearer token used when \-\-token is not given.
|
|
106
|
+
.TP
|
|
107
|
+
\fBROARK_BASE_URL\fR
|
|
108
|
+
API base URL.
|
|
109
|
+
.TP
|
|
110
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
111
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
112
|
+
.TP
|
|
113
|
+
\fBNO_COLOR\fR
|
|
114
|
+
Disables colour when set to any value.
|
|
115
|
+
.SH "EXIT STATUS"
|
|
116
|
+
.TP
|
|
117
|
+
\fB0\fR
|
|
118
|
+
The command succeeded.
|
|
119
|
+
.TP
|
|
120
|
+
\fB1\fR
|
|
121
|
+
The API rejected the request.
|
|
122
|
+
.TP
|
|
123
|
+
\fB2\fR
|
|
124
|
+
The command line was wrong.
|
|
125
|
+
.TP
|
|
126
|
+
\fB3\fR
|
|
127
|
+
No credential, or the credential was refused.
|
|
128
|
+
.TP
|
|
129
|
+
\fB4\fR
|
|
130
|
+
The addressed resource does not exist.
|
|
131
|
+
.TP
|
|
132
|
+
\fB5\fR
|
|
133
|
+
The request never completed: connection, timeout, or abort.
|
|
134
|
+
.SH "SEE ALSO"
|
|
135
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-LIVE\-REPORT\-DELETE" "1" "" "roark-live-report-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-live\-report\-delete \- Delete a live report
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark live\-report delete
|
|
7
|
+
\fIreport\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes the report and stops its scheduled reports.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/live\-report/{reportId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIreport\-id\fR
|
|
15
|
+
The live report ID
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark live\-report delete <report\-id>
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-LIVE\-REPORT\-DOCUMENT\-GET" "1" "" "roark-live-report-document-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-live\-report\-document\-get \- Get a report document
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark live\-report document get
|
|
7
|
+
\fIreport\-id\fR \fIdocument\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns one written report. `document` is null until `status` is READY. Theme excerpts and grader quotes (call transcript text) are included only for keys with transcript:read.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/live\-report/{reportId}/document/{documentId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIreport\-id\fR
|
|
15
|
+
The live report ID
|
|
16
|
+
.TP
|
|
17
|
+
\fIdocument\-id\fR
|
|
18
|
+
The report document ID
|
|
19
|
+
.SH "GLOBAL OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
22
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
25
|
+
Skip confirmation prompts.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-no\-input\fR
|
|
28
|
+
Never prompt; fail instead.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
31
|
+
API base URL.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
34
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
37
|
+
Request timeout in milliseconds.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
40
|
+
Retries for retryable failures.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
43
|
+
Output format: auto, json, jsonl, plain.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Shorthand for \-\-format json.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-no\-color\fR
|
|
49
|
+
Disable colour.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
52
|
+
Suppress non\-essential output.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
55
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
56
|
+
.SH "EXAMPLES"
|
|
57
|
+
.PP
|
|
58
|
+
.RS 4
|
|
59
|
+
.nf
|
|
60
|
+
roark live\-report document get <report\-id> <document\-id>
|
|
61
|
+
.fi
|
|
62
|
+
.RE
|
|
63
|
+
.SH "ENVIRONMENT"
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
66
|
+
Bearer token used when \-\-token is not given.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_BASE_URL\fR
|
|
69
|
+
API base URL.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
72
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
73
|
+
.TP
|
|
74
|
+
\fBNO_COLOR\fR
|
|
75
|
+
Disables colour when set to any value.
|
|
76
|
+
.SH "EXIT STATUS"
|
|
77
|
+
.TP
|
|
78
|
+
\fB0\fR
|
|
79
|
+
The command succeeded.
|
|
80
|
+
.TP
|
|
81
|
+
\fB1\fR
|
|
82
|
+
The API rejected the request.
|
|
83
|
+
.TP
|
|
84
|
+
\fB2\fR
|
|
85
|
+
The command line was wrong.
|
|
86
|
+
.TP
|
|
87
|
+
\fB3\fR
|
|
88
|
+
No credential, or the credential was refused.
|
|
89
|
+
.TP
|
|
90
|
+
\fB4\fR
|
|
91
|
+
The addressed resource does not exist.
|
|
92
|
+
.TP
|
|
93
|
+
\fB5\fR
|
|
94
|
+
The request never completed: connection, timeout, or abort.
|
|
95
|
+
.SH "SEE ALSO"
|
|
96
|
+
.BR roark (1)
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-LIVE\-REPORT\-DOCUMENT\-LIST" "1" "" "roark-live-report-document-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-live\-report\-document\-list \- List report documents
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark live\-report document list
|
|
7
|
+
\fIreport\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Lists a report's documents, newest period first.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/live\-report/{reportId}/document
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIreport\-id\fR
|
|
15
|
+
The report\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
19
|
+
Page size, at most 100. Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-offset\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.SH "GLOBAL OPTIONS"
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
26
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
29
|
+
Skip confirmation prompts.
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-no\-input\fR
|
|
32
|
+
Never prompt; fail instead.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
35
|
+
API base URL.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
38
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
41
|
+
Request timeout in milliseconds.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
44
|
+
Retries for retryable failures.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
47
|
+
Output format: auto, json, jsonl, plain.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-json\fR
|
|
50
|
+
Shorthand for \-\-format json.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-no\-color\fR
|
|
53
|
+
Disable colour.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
56
|
+
Suppress non\-essential output.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
59
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
60
|
+
.SH "EXAMPLES"
|
|
61
|
+
.PP
|
|
62
|
+
.RS 4
|
|
63
|
+
.nf
|
|
64
|
+
roark live\-report document list <report\-id>
|
|
65
|
+
.fi
|
|
66
|
+
.RE
|
|
67
|
+
.SH "ENVIRONMENT"
|
|
68
|
+
.TP
|
|
69
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
70
|
+
Bearer token used when \-\-token is not given.
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_BASE_URL\fR
|
|
73
|
+
API base URL.
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
76
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
77
|
+
.TP
|
|
78
|
+
\fBNO_COLOR\fR
|
|
79
|
+
Disables colour when set to any value.
|
|
80
|
+
.SH "EXIT STATUS"
|
|
81
|
+
.TP
|
|
82
|
+
\fB0\fR
|
|
83
|
+
The command succeeded.
|
|
84
|
+
.TP
|
|
85
|
+
\fB1\fR
|
|
86
|
+
The API rejected the request.
|
|
87
|
+
.TP
|
|
88
|
+
\fB2\fR
|
|
89
|
+
The command line was wrong.
|
|
90
|
+
.TP
|
|
91
|
+
\fB3\fR
|
|
92
|
+
No credential, or the credential was refused.
|
|
93
|
+
.TP
|
|
94
|
+
\fB4\fR
|
|
95
|
+
The addressed resource does not exist.
|
|
96
|
+
.TP
|
|
97
|
+
\fB5\fR
|
|
98
|
+
The request never completed: connection, timeout, or abort.
|
|
99
|
+
.SH "SEE ALSO"
|
|
100
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-LIVE\-REPORT\-GET" "1" "" "roark-live-report-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-live\-report\-get \- Get a live report
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark live\-report get
|
|
7
|
+
\fIreport\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Get a live report
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/live\-report/{reportId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIreport\-id\fR
|
|
15
|
+
The live report ID
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark live\-report get <report\-id>
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-LIVE\-REPORT\-LIST" "1" "" "roark-live-report-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-live\-report\-list \- List live reports
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark live\-report list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Lists the project's saved live call reports, newest first.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/live\-report
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
15
|
+
Page size, at most 100. Optional.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-offset\fR \fI<value>\fR
|
|
18
|
+
Optional.
|
|
19
|
+
.SH "GLOBAL OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
22
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
25
|
+
Skip confirmation prompts.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-no\-input\fR
|
|
28
|
+
Never prompt; fail instead.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
31
|
+
API base URL.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
34
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
37
|
+
Request timeout in milliseconds.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
40
|
+
Retries for retryable failures.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
43
|
+
Output format: auto, json, jsonl, plain.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Shorthand for \-\-format json.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-no\-color\fR
|
|
49
|
+
Disable colour.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
52
|
+
Suppress non\-essential output.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
55
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
56
|
+
.SH "EXAMPLES"
|
|
57
|
+
.PP
|
|
58
|
+
.RS 4
|
|
59
|
+
.nf
|
|
60
|
+
roark live\-report list
|
|
61
|
+
.fi
|
|
62
|
+
.RE
|
|
63
|
+
.SH "ENVIRONMENT"
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
66
|
+
Bearer token used when \-\-token is not given.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_BASE_URL\fR
|
|
69
|
+
API base URL.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
72
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
73
|
+
.TP
|
|
74
|
+
\fBNO_COLOR\fR
|
|
75
|
+
Disables colour when set to any value.
|
|
76
|
+
.SH "EXIT STATUS"
|
|
77
|
+
.TP
|
|
78
|
+
\fB0\fR
|
|
79
|
+
The command succeeded.
|
|
80
|
+
.TP
|
|
81
|
+
\fB1\fR
|
|
82
|
+
The API rejected the request.
|
|
83
|
+
.TP
|
|
84
|
+
\fB2\fR
|
|
85
|
+
The command line was wrong.
|
|
86
|
+
.TP
|
|
87
|
+
\fB3\fR
|
|
88
|
+
No credential, or the credential was refused.
|
|
89
|
+
.TP
|
|
90
|
+
\fB4\fR
|
|
91
|
+
The addressed resource does not exist.
|
|
92
|
+
.TP
|
|
93
|
+
\fB5\fR
|
|
94
|
+
The request never completed: connection, timeout, or abort.
|
|
95
|
+
.SH "SEE ALSO"
|
|
96
|
+
.BR roark (1)
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-LIVE\-REPORT\-RUN" "1" "" "roark-live-report-run" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-live\-report\-run \- Generate a live report document
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark live\-report run
|
|
7
|
+
\fIreport\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Writes the report now, for its latest closed period or a custom window (`periodStart` + `periodEnd`, at most 92 days, ended). Returns 202 with the document in PENDING; poll GET /v1/live\-report/{reportId}/document/{documentId} until `status` is READY or FAILED (typically a few minutes). An identical request already in flight is returned as\-is. A generated document is not emailed.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/live\-report/{reportId}/generate
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIreport\-id\fR
|
|
15
|
+
The live report ID
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-period\-start\fR \fI<value>\fR
|
|
19
|
+
ISO 8601 start of a custom window. Omit both for the latest closed period. Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-period\-end\fR \fI<value>\fR
|
|
22
|
+
ISO 8601 end (exclusive) of a custom window. Requires periodStart. Optional.
|
|
23
|
+
.SH "GLOBAL OPTIONS"
|
|
24
|
+
.TP
|
|
25
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
26
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
29
|
+
Skip confirmation prompts.
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-no\-input\fR
|
|
32
|
+
Never prompt; fail instead.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
35
|
+
API base URL.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
38
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
41
|
+
Request timeout in milliseconds.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
44
|
+
Retries for retryable failures.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
47
|
+
Output format: auto, json, jsonl, plain.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-json\fR
|
|
50
|
+
Shorthand for \-\-format json.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-no\-color\fR
|
|
53
|
+
Disable colour.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
56
|
+
Suppress non\-essential output.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
59
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
60
|
+
.SH "EXAMPLES"
|
|
61
|
+
.PP
|
|
62
|
+
.RS 4
|
|
63
|
+
.nf
|
|
64
|
+
roark live\-report run <report\-id>
|
|
65
|
+
.fi
|
|
66
|
+
.RE
|
|
67
|
+
.SH "ENVIRONMENT"
|
|
68
|
+
.TP
|
|
69
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
70
|
+
Bearer token used when \-\-token is not given.
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_BASE_URL\fR
|
|
73
|
+
API base URL.
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
76
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
77
|
+
.TP
|
|
78
|
+
\fBNO_COLOR\fR
|
|
79
|
+
Disables colour when set to any value.
|
|
80
|
+
.SH "EXIT STATUS"
|
|
81
|
+
.TP
|
|
82
|
+
\fB0\fR
|
|
83
|
+
The command succeeded.
|
|
84
|
+
.TP
|
|
85
|
+
\fB1\fR
|
|
86
|
+
The API rejected the request.
|
|
87
|
+
.TP
|
|
88
|
+
\fB2\fR
|
|
89
|
+
The command line was wrong.
|
|
90
|
+
.TP
|
|
91
|
+
\fB3\fR
|
|
92
|
+
No credential, or the credential was refused.
|
|
93
|
+
.TP
|
|
94
|
+
\fB4\fR
|
|
95
|
+
The addressed resource does not exist.
|
|
96
|
+
.TP
|
|
97
|
+
\fB5\fR
|
|
98
|
+
The request never completed: connection, timeout, or abort.
|
|
99
|
+
.SH "SEE ALSO"
|
|
100
|
+
.BR roark (1)
|