@roarkanalytics/cli 0.46.0 → 0.50.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 +35 -0
- package/README.md +32 -0
- package/commands.js +963 -141
- package/completions.js +4 -4
- package/man/roark-analytics-query.1 +114 -0
- package/man/roark-analytics-schema-get.1 +89 -0
- package/man/roark-call-batch-delete.1 +93 -0
- package/man/roark-call-cost-get.1 +93 -0
- package/man/roark-call-delete.1 +93 -0
- package/man/roark-call-list.1 +3 -0
- package/man/roark-dashboard-create.1 +108 -0
- package/man/roark-dashboard-data-get.1 +103 -0
- package/man/roark-dashboard-delete.1 +93 -0
- package/man/roark-dashboard-get.1 +93 -0
- package/man/roark-dashboard-list.1 +89 -0
- package/man/roark-dashboard-update.1 +112 -0
- package/man/roark-dashboard-widget-create.1 +121 -0
- package/man/roark-dashboard-widget-data-get.1 +106 -0
- package/man/roark-dashboard-widget-delete.1 +96 -0
- package/man/roark-dashboard-widget-update.1 +124 -0
- package/man/roark-simulation-plan-job-cost-get.1 +93 -0
- package/man/roark-usage-get.1 +99 -0
- package/man/roark.1 +51 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +19 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-ANALYTICS\-QUERY" "1" "" "roark-analytics-query" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-analytics\-query \- Run an analytics query
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark analytics query
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Aggregates metric values and conversation counts over a time window and returns one series per measure, with a total for the window and per\-interval buckets. The same query a dashboard widget runs, without saving anything. \- `measures`: what to aggregate. A METRIC measure names its metric by slug; CONVERSATION counts conversations; UPTIME reads health checks. The aggregation defaults by the metric's output type. \- `timeRange`: LAST n DAYS/WEEKS/MONTHS, a CALENDAR_ALIGNED period (TODAY, THIS_MONTH, ...), FIXED from/to, or SINCE. Defaults to the last 30 days; at most 731 days. Calendar periods and buckets align to `timezone` (IANA, default UTC). \- `filters` apply to every measure; a measure's own `filters` add to them. \- `breakdown` on a measure returns one series per value (largest 50 kept). \- `comparisonGroups` (2 to 5) run every measure once per named filter set; `comparisonMode: PREVIOUS_PERIOD` adds the preceding window's values. Values are in the metric's display units. A PASS_RATE is a 0 to 1 share; `sampleSize` 0 means no data. A query the analytics store cannot answer returns 400 naming the unsupported part.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/analytics/query
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-measures\fR \fI<value>\fR
|
|
15
|
+
What to aggregate: 1 to 10 measures. Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-filters\fR \fI<value>\fR
|
|
18
|
+
Applied to every measure, on top of each measure's own filters. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-interval\fR \fI<value>\fR
|
|
21
|
+
Bucket size. Defaults from the window's length and steps coarser when the window would exceed 500 buckets. One of: HOUR, DAY, WEEK, MONTH. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-comparison\-mode\fR \fI<value>\fR
|
|
24
|
+
PREVIOUS_PERIOD adds the preceding window of the same length to every series. One of: NONE, PREVIOUS_PERIOD. Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-comparison\-groups\fR \fI<value>\fR
|
|
27
|
+
Run every measure once per named filter set, e.g. one group per agent. Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-time\-range\fR \fI<value>\fR
|
|
30
|
+
Defaults to the last 30 days. Optional.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-timezone\fR \fI<value>\fR
|
|
33
|
+
IANA zone that buckets and calendar periods align to, e.g. America/New_York. Defaults to UTC. Optional.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-include\-buckets\fR
|
|
36
|
+
Set false to return only the window totals. Optional.
|
|
37
|
+
.SH "GLOBAL OPTIONS"
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
40
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
43
|
+
Skip confirmation prompts.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-input\fR
|
|
46
|
+
Never prompt; fail instead.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
49
|
+
API base URL.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
52
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
55
|
+
Request timeout in milliseconds.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
58
|
+
Retries for retryable failures.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
61
|
+
Output format: auto, json, jsonl, plain.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-json\fR
|
|
64
|
+
Shorthand for \-\-format json.
|
|
65
|
+
.TP
|
|
66
|
+
\fB\-\-no\-color\fR
|
|
67
|
+
Disable colour.
|
|
68
|
+
.TP
|
|
69
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
70
|
+
Suppress non\-essential output.
|
|
71
|
+
.TP
|
|
72
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
73
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
74
|
+
.SH "EXAMPLES"
|
|
75
|
+
.PP
|
|
76
|
+
.RS 4
|
|
77
|
+
.nf
|
|
78
|
+
roark analytics query \-\-measures <value>
|
|
79
|
+
.fi
|
|
80
|
+
.RE
|
|
81
|
+
.SH "ENVIRONMENT"
|
|
82
|
+
.TP
|
|
83
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
84
|
+
Bearer token used when \-\-token is not given.
|
|
85
|
+
.TP
|
|
86
|
+
\fBROARK_BASE_URL\fR
|
|
87
|
+
API base URL.
|
|
88
|
+
.TP
|
|
89
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
90
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
91
|
+
.TP
|
|
92
|
+
\fBNO_COLOR\fR
|
|
93
|
+
Disables colour when set to any value.
|
|
94
|
+
.SH "EXIT STATUS"
|
|
95
|
+
.TP
|
|
96
|
+
\fB0\fR
|
|
97
|
+
The command succeeded.
|
|
98
|
+
.TP
|
|
99
|
+
\fB1\fR
|
|
100
|
+
The API rejected the request.
|
|
101
|
+
.TP
|
|
102
|
+
\fB2\fR
|
|
103
|
+
The command line was wrong.
|
|
104
|
+
.TP
|
|
105
|
+
\fB3\fR
|
|
106
|
+
No credential, or the credential was refused.
|
|
107
|
+
.TP
|
|
108
|
+
\fB4\fR
|
|
109
|
+
The addressed resource does not exist.
|
|
110
|
+
.TP
|
|
111
|
+
\fB5\fR
|
|
112
|
+
The request never completed: connection, timeout, or abort.
|
|
113
|
+
.SH "SEE ALSO"
|
|
114
|
+
.BR roark (1)
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-ANALYTICS\-SCHEMA\-GET" "1" "" "roark-analytics-schema-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-analytics\-schema\-get \- Get the analytics schema
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark analytics schema get
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Lists what can go into an analytics query for this project: every metric by slug with its output type, default aggregation and the aggregations it supports; the measure types; the filter and breakdown types with the properties each accepts; and the custom call properties seen in the project. Read this first when building a query.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/analytics/schema
|
|
12
|
+
.SH "GLOBAL OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
15
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
18
|
+
Skip confirmation prompts.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-no\-input\fR
|
|
21
|
+
Never prompt; fail instead.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
24
|
+
API base URL.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
27
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
30
|
+
Request timeout in milliseconds.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
33
|
+
Retries for retryable failures.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
36
|
+
Output format: auto, json, jsonl, plain.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-json\fR
|
|
39
|
+
Shorthand for \-\-format json.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-no\-color\fR
|
|
42
|
+
Disable colour.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
45
|
+
Suppress non\-essential output.
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
48
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
49
|
+
.SH "EXAMPLES"
|
|
50
|
+
.PP
|
|
51
|
+
.RS 4
|
|
52
|
+
.nf
|
|
53
|
+
roark analytics schema get
|
|
54
|
+
.fi
|
|
55
|
+
.RE
|
|
56
|
+
.SH "ENVIRONMENT"
|
|
57
|
+
.TP
|
|
58
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
59
|
+
Bearer token used when \-\-token is not given.
|
|
60
|
+
.TP
|
|
61
|
+
\fBROARK_BASE_URL\fR
|
|
62
|
+
API base URL.
|
|
63
|
+
.TP
|
|
64
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
65
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
66
|
+
.TP
|
|
67
|
+
\fBNO_COLOR\fR
|
|
68
|
+
Disables colour when set to any value.
|
|
69
|
+
.SH "EXIT STATUS"
|
|
70
|
+
.TP
|
|
71
|
+
\fB0\fR
|
|
72
|
+
The command succeeded.
|
|
73
|
+
.TP
|
|
74
|
+
\fB1\fR
|
|
75
|
+
The API rejected the request.
|
|
76
|
+
.TP
|
|
77
|
+
\fB2\fR
|
|
78
|
+
The command line was wrong.
|
|
79
|
+
.TP
|
|
80
|
+
\fB3\fR
|
|
81
|
+
No credential, or the credential was refused.
|
|
82
|
+
.TP
|
|
83
|
+
\fB4\fR
|
|
84
|
+
The addressed resource does not exist.
|
|
85
|
+
.TP
|
|
86
|
+
\fB5\fR
|
|
87
|
+
The request never completed: connection, timeout, or abort.
|
|
88
|
+
.SH "SEE ALSO"
|
|
89
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CALL\-BATCH\-DELETE" "1" "" "roark-call-batch-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-call\-batch\-delete \- Delete calls in batch
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark call batch delete
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes up to 100 calls by ID in one request. Each deleted call, its metrics and its analysis are hidden from every read, and any analysis still running on it is cancelled. IDs that do not exist in this project, or were already deleted, are returned in notFoundCallIds and left untouched. The request succeeds even when none of the calls are found. IDs are returned lowercase, each once.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/call/batch\-delete
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-call\-ids\fR \fI<value>\fR
|
|
15
|
+
IDs of the calls to delete, at most 100. Repeated IDs are counted once. Repeatable. Required.
|
|
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 call batch delete \-\-call\-ids <value>
|
|
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,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CALL\-COST\-GET" "1" "" "roark-call-cost-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-call\-cost\-get \- Get call cost
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark call cost get
|
|
7
|
+
\fIcall\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
The billable spend attributed to one call, split by cost type, with every cost line behind it. Simulated calls include the costs their simulation incurred before the call connected. Amounts are billable spend only, in exact micro\-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/call/{callId}/cost
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcall\-id\fR
|
|
15
|
+
The call\-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 call cost get <call\-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,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CALL\-DELETE" "1" "" "roark-call-delete" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-call\-delete \- Delete a call
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark call delete
|
|
7
|
+
\fIcall\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Deletes a call by its ID. The call, its metrics and its analysis are hidden from every read, and any analysis still running on it is cancelled. Returns 404 when the call does not exist in this project or was already deleted.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/call/{callId}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcall\-id\fR
|
|
15
|
+
The call\-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 call delete <call\-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)
|
package/man/roark-call-list.1
CHANGED
|
@@ -43,6 +43,9 @@ true: only simulated calls their run's results count (not invalidated, for examp
|
|
|
43
43
|
.TP
|
|
44
44
|
\fB\-\-exclude\-hidden\-runs\fR \fI<value>\fR
|
|
45
45
|
true: leave out calls from runs hidden from the runs list. Live calls stay in. false is the same as leaving it out. One of: true, false. Optional.
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-properties\fR \fI<value>\fR
|
|
48
|
+
Filter on custom properties, one entry per property name: properties[<name>][exists]=true keeps calls that have the property set (whatever the value), properties[<name>][exists]=false keeps calls missing it (never sent, sent as null, or removed). A property the project has never seen is missing on every call. Names match the way properties are stored, so planTier and plan_tier are one property. At most 20 properties; a name taken by a built\-in call filter, such as status, is rejected with 400. Optional.
|
|
46
49
|
.SH "GLOBAL OPTIONS"
|
|
47
50
|
.TP
|
|
48
51
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-DASHBOARD\-CREATE" "1" "" "roark-dashboard-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-dashboard\-create \- Create a dashboard
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark dashboard create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Creates a dashboard with its widgets. Each widget is an analytics query (see POST /v1/analytics/query) with a name unique on the dashboard, a `display` (LINE, NUMBER, RADAR, STACKED_BAR, TABLE) and a `size` (SMALL, MEDIUM, LARGE, EXTRA_LARGE). Widgets render top to bottom in the order given. Dashboard `filters` apply over every widget and must be conversation\-level: AGENT_PROPERTY, CALL_PROPERTY, MODALITY, DATASET or METRIC_VALUE. On a field a widget already filters, the dashboard's wins.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/dashboard
|
|
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\-\-time\-range\fR \fI<value>\fR
|
|
21
|
+
The window: LAST n DAYS/WEEKS/MONTHS up to now, a CALENDAR_ALIGNED period (TODAY, YESTERDAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, THIS_YEAR, LAST_YEAR), FIXED from/to, or SINCE a date. At most 731 days (two years). Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-filters\fR \fI<value>\fR
|
|
24
|
+
Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-is\-default\fR
|
|
27
|
+
Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-widgets\fR \fI<value>\fR
|
|
30
|
+
Optional.
|
|
31
|
+
.SH "GLOBAL OPTIONS"
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
34
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
37
|
+
Skip confirmation prompts.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-no\-input\fR
|
|
40
|
+
Never prompt; fail instead.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
43
|
+
API base URL.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
46
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
49
|
+
Request timeout in milliseconds.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
52
|
+
Retries for retryable failures.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
55
|
+
Output format: auto, json, jsonl, plain.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-json\fR
|
|
58
|
+
Shorthand for \-\-format json.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-no\-color\fR
|
|
61
|
+
Disable colour.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
64
|
+
Suppress non\-essential output.
|
|
65
|
+
.TP
|
|
66
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
67
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
68
|
+
.SH "EXAMPLES"
|
|
69
|
+
.PP
|
|
70
|
+
.RS 4
|
|
71
|
+
.nf
|
|
72
|
+
roark dashboard create \-\-name <value>
|
|
73
|
+
.fi
|
|
74
|
+
.RE
|
|
75
|
+
.SH "ENVIRONMENT"
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
78
|
+
Bearer token used when \-\-token is not given.
|
|
79
|
+
.TP
|
|
80
|
+
\fBROARK_BASE_URL\fR
|
|
81
|
+
API base URL.
|
|
82
|
+
.TP
|
|
83
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
84
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
85
|
+
.TP
|
|
86
|
+
\fBNO_COLOR\fR
|
|
87
|
+
Disables colour when set to any value.
|
|
88
|
+
.SH "EXIT STATUS"
|
|
89
|
+
.TP
|
|
90
|
+
\fB0\fR
|
|
91
|
+
The command succeeded.
|
|
92
|
+
.TP
|
|
93
|
+
\fB1\fR
|
|
94
|
+
The API rejected the request.
|
|
95
|
+
.TP
|
|
96
|
+
\fB2\fR
|
|
97
|
+
The command line was wrong.
|
|
98
|
+
.TP
|
|
99
|
+
\fB3\fR
|
|
100
|
+
No credential, or the credential was refused.
|
|
101
|
+
.TP
|
|
102
|
+
\fB4\fR
|
|
103
|
+
The addressed resource does not exist.
|
|
104
|
+
.TP
|
|
105
|
+
\fB5\fR
|
|
106
|
+
The request never completed: connection, timeout, or abort.
|
|
107
|
+
.SH "SEE ALSO"
|
|
108
|
+
.BR roark (1)
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-DASHBOARD\-DATA\-GET" "1" "" "roark-dashboard-data-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-dashboard\-data\-get \- Get dashboard data
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark dashboard data get
|
|
7
|
+
\fIdashboard\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Runs every widget on the dashboard and returns each one's series, exactly as the dashboard shows them: over the dashboard's saved window and with its filters applied. Pass `from` (and optionally `to`) to read a different window, and `timezone` to align buckets to a zone.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/dashboard/{dashboardId}/data
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIdashboard\-id\fR
|
|
15
|
+
The dashboard\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-from\fR \fI<value>\fR
|
|
19
|
+
ISO 8601 start. Overrides the saved window; without `to`, runs until now. Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-to\fR \fI<value>\fR
|
|
22
|
+
ISO 8601 end. Requires `from`. Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-timezone\fR \fI<value>\fR
|
|
25
|
+
IANA zone buckets and calendar periods align to. Default UTC. Optional.
|
|
26
|
+
.SH "GLOBAL OPTIONS"
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
29
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
32
|
+
Skip confirmation prompts.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-no\-input\fR
|
|
35
|
+
Never prompt; fail instead.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
38
|
+
API base URL.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
41
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
44
|
+
Request timeout in milliseconds.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
47
|
+
Retries for retryable failures.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
50
|
+
Output format: auto, json, jsonl, plain.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-json\fR
|
|
53
|
+
Shorthand for \-\-format json.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-no\-color\fR
|
|
56
|
+
Disable colour.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
59
|
+
Suppress non\-essential output.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
62
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
63
|
+
.SH "EXAMPLES"
|
|
64
|
+
.PP
|
|
65
|
+
.RS 4
|
|
66
|
+
.nf
|
|
67
|
+
roark dashboard data get <dashboard\-id>
|
|
68
|
+
.fi
|
|
69
|
+
.RE
|
|
70
|
+
.SH "ENVIRONMENT"
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
73
|
+
Bearer token used when \-\-token is not given.
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_BASE_URL\fR
|
|
76
|
+
API base URL.
|
|
77
|
+
.TP
|
|
78
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
79
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
80
|
+
.TP
|
|
81
|
+
\fBNO_COLOR\fR
|
|
82
|
+
Disables colour when set to any value.
|
|
83
|
+
.SH "EXIT STATUS"
|
|
84
|
+
.TP
|
|
85
|
+
\fB0\fR
|
|
86
|
+
The command succeeded.
|
|
87
|
+
.TP
|
|
88
|
+
\fB1\fR
|
|
89
|
+
The API rejected the request.
|
|
90
|
+
.TP
|
|
91
|
+
\fB2\fR
|
|
92
|
+
The command line was wrong.
|
|
93
|
+
.TP
|
|
94
|
+
\fB3\fR
|
|
95
|
+
No credential, or the credential was refused.
|
|
96
|
+
.TP
|
|
97
|
+
\fB4\fR
|
|
98
|
+
The addressed resource does not exist.
|
|
99
|
+
.TP
|
|
100
|
+
\fB5\fR
|
|
101
|
+
The request never completed: connection, timeout, or abort.
|
|
102
|
+
.SH "SEE ALSO"
|
|
103
|
+
.BR roark (1)
|