@trillboards/cli 0.1.0
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/README.md +1288 -0
- package/bin/dev.cmd +3 -0
- package/bin/dev.js +5 -0
- package/bin/run.cmd +3 -0
- package/bin/run.js +5 -0
- package/dist/base-command.d.ts +20 -0
- package/dist/base-command.js +60 -0
- package/dist/commands/api.d.ts +14 -0
- package/dist/commands/api.js +80 -0
- package/dist/commands/audience/live.d.ts +14 -0
- package/dist/commands/audience/live.js +117 -0
- package/dist/commands/billing/usage.d.ts +10 -0
- package/dist/commands/billing/usage.js +92 -0
- package/dist/commands/billing.d.ts +6 -0
- package/dist/commands/billing.js +49 -0
- package/dist/commands/debug.d.ts +10 -0
- package/dist/commands/debug.js +156 -0
- package/dist/commands/doctor.d.ts +6 -0
- package/dist/commands/doctor.js +145 -0
- package/dist/commands/earnings.d.ts +15 -0
- package/dist/commands/earnings.js +182 -0
- package/dist/commands/endpoints/index.d.ts +9 -0
- package/dist/commands/endpoints/index.js +35 -0
- package/dist/commands/errors/index.d.ts +9 -0
- package/dist/commands/errors/index.js +34 -0
- package/dist/commands/fill-rate.d.ts +12 -0
- package/dist/commands/fill-rate.js +141 -0
- package/dist/commands/generated/generated-changelog-query.d.ts +14 -0
- package/dist/commands/generated/generated-changelog-query.js +35 -0
- package/dist/commands/generated/generated-data-api-aggregate.d.ts +15 -0
- package/dist/commands/generated/generated-data-api-aggregate.js +38 -0
- package/dist/commands/generated/generated-data-api-list-screens.d.ts +16 -0
- package/dist/commands/generated/generated-data-api-list-screens.js +41 -0
- package/dist/commands/generated/generated-data-api-lookalike-screens.d.ts +15 -0
- package/dist/commands/generated/generated-data-api-lookalike-screens.js +38 -0
- package/dist/commands/generated/generated-data-api-query-dsl.d.ts +13 -0
- package/dist/commands/generated/generated-data-api-query-dsl.js +32 -0
- package/dist/commands/generated/generated-data-api-screen-audience-history.d.ts +17 -0
- package/dist/commands/generated/generated-data-api-screen-audience-history.js +41 -0
- package/dist/commands/generated/generated-data-api-screen-audience-live.d.ts +14 -0
- package/dist/commands/generated/generated-data-api-screen-audience-live.js +32 -0
- package/dist/commands/generated/generated-data-api-semantic-search.d.ts +16 -0
- package/dist/commands/generated/generated-data-api-semantic-search.js +41 -0
- package/dist/commands/generated/generated-data-api-stats.d.ts +12 -0
- package/dist/commands/generated/generated-data-api-stats.js +26 -0
- package/dist/commands/generated/generated-data-api-stream.d.ts +14 -0
- package/dist/commands/generated/generated-data-api-stream.js +35 -0
- package/dist/commands/generated/generated-data-api-usage.d.ts +13 -0
- package/dist/commands/generated/generated-data-api-usage.js +32 -0
- package/dist/commands/generated/generated-device-ota-manifest.d.ts +13 -0
- package/dist/commands/generated/generated-device-ota-manifest.js +32 -0
- package/dist/commands/generated/generated-example-healthcheck.d.ts +13 -0
- package/dist/commands/generated/generated-example-healthcheck.js +32 -0
- package/dist/commands/generated/generated-playground-dry-run.d.ts +14 -0
- package/dist/commands/generated/generated-playground-dry-run.js +32 -0
- package/dist/commands/generated/generated-request-metadata-get.d.ts +14 -0
- package/dist/commands/generated/generated-request-metadata-get.js +32 -0
- package/dist/commands/generated/generated-sdk-enrich.d.ts +13 -0
- package/dist/commands/generated/generated-sdk-enrich.js +32 -0
- package/dist/commands/generated/generated-sdk-impression.d.ts +13 -0
- package/dist/commands/generated/generated-sdk-impression.js +32 -0
- package/dist/commands/generated/generated-sdk-qr-beacon.d.ts +13 -0
- package/dist/commands/generated/generated-sdk-qr-beacon.js +32 -0
- package/dist/commands/generated/generated-sdk-qr-scan.d.ts +13 -0
- package/dist/commands/generated/generated-sdk-qr-scan.js +32 -0
- package/dist/commands/generated/generated-sensing-paired-training-upload.d.ts +13 -0
- package/dist/commands/generated/generated-sensing-paired-training-upload.js +32 -0
- package/dist/commands/listen.d.ts +39 -0
- package/dist/commands/listen.js +245 -0
- package/dist/commands/login.d.ts +7 -0
- package/dist/commands/login.js +68 -0
- package/dist/commands/logs/tail.d.ts +47 -0
- package/dist/commands/logs/tail.js +240 -0
- package/dist/commands/reconcile.d.ts +9 -0
- package/dist/commands/reconcile.js +58 -0
- package/dist/commands/sandbox/create.d.ts +6 -0
- package/dist/commands/sandbox/create.js +35 -0
- package/dist/commands/sandbox/emit.d.ts +12 -0
- package/dist/commands/sandbox/emit.js +57 -0
- package/dist/commands/sandbox/reset.d.ts +6 -0
- package/dist/commands/sandbox/reset.js +34 -0
- package/dist/commands/sandbox/status.d.ts +6 -0
- package/dist/commands/sandbox/status.js +58 -0
- package/dist/commands/screens/watch.d.ts +14 -0
- package/dist/commands/screens/watch.js +158 -0
- package/dist/commands/trigger.d.ts +9 -0
- package/dist/commands/trigger.js +53 -0
- package/dist/commands/validate.d.ts +12 -0
- package/dist/commands/validate.js +93 -0
- package/dist/commands/whoami.d.ts +6 -0
- package/dist/commands/whoami.js +39 -0
- package/dist/config.d.ts +10 -0
- package/dist/config.js +32 -0
- package/dist/format-helpers.d.ts +46 -0
- package/dist/format-helpers.js +96 -0
- package/dist/http.d.ts +13 -0
- package/dist/http.js +51 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/output.d.ts +2 -0
- package/dist/output.js +78 -0
- package/oclif.manifest.json +2697 -0
- package/package.json +94 -0
package/README.md
ADDED
|
@@ -0,0 +1,1288 @@
|
|
|
1
|
+
trillboards-cli
|
|
2
|
+
=================
|
|
3
|
+
|
|
4
|
+
A new CLI generated with oclif
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
[](https://oclif.io)
|
|
8
|
+
[](https://npmjs.org/package/trillboards-cli)
|
|
9
|
+
[](https://npmjs.org/package/trillboards-cli)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<!-- toc -->
|
|
13
|
+
* [Usage](#usage)
|
|
14
|
+
* [Commands](#commands)
|
|
15
|
+
<!-- tocstop -->
|
|
16
|
+
# Usage
|
|
17
|
+
<!-- usage -->
|
|
18
|
+
```sh-session
|
|
19
|
+
$ npm install -g @trillboards/cli
|
|
20
|
+
$ trillboards COMMAND
|
|
21
|
+
running command...
|
|
22
|
+
$ trillboards (--version)
|
|
23
|
+
@trillboards/cli/0.1.0 darwin-arm64 node-v22.22.0
|
|
24
|
+
$ trillboards --help [COMMAND]
|
|
25
|
+
USAGE
|
|
26
|
+
$ trillboards COMMAND
|
|
27
|
+
...
|
|
28
|
+
```
|
|
29
|
+
<!-- usagestop -->
|
|
30
|
+
# Commands
|
|
31
|
+
<!-- commands -->
|
|
32
|
+
* [`trillboards api METHOD PATH`](#trillboards-api-method-path)
|
|
33
|
+
* [`trillboards audience live SCREEN_ID`](#trillboards-audience-live-screen_id)
|
|
34
|
+
* [`trillboards autocomplete [SHELL]`](#trillboards-autocomplete-shell)
|
|
35
|
+
* [`trillboards billing`](#trillboards-billing)
|
|
36
|
+
* [`trillboards billing usage`](#trillboards-billing-usage)
|
|
37
|
+
* [`trillboards debug SCREEN_ID`](#trillboards-debug-screen_id)
|
|
38
|
+
* [`trillboards doctor`](#trillboards-doctor)
|
|
39
|
+
* [`trillboards earnings [MODE]`](#trillboards-earnings-mode)
|
|
40
|
+
* [`trillboards endpoints`](#trillboards-endpoints)
|
|
41
|
+
* [`trillboards errors [CODE]`](#trillboards-errors-code)
|
|
42
|
+
* [`trillboards fill-rate`](#trillboards-fill-rate)
|
|
43
|
+
* [`trillboards generated generated-changelog-query`](#trillboards-generated-generated-changelog-query)
|
|
44
|
+
* [`trillboards generated generated-data-api-aggregate`](#trillboards-generated-generated-data-api-aggregate)
|
|
45
|
+
* [`trillboards generated generated-data-api-list-screens`](#trillboards-generated-generated-data-api-list-screens)
|
|
46
|
+
* [`trillboards generated generated-data-api-lookalike-screens`](#trillboards-generated-generated-data-api-lookalike-screens)
|
|
47
|
+
* [`trillboards generated generated-data-api-query-dsl`](#trillboards-generated-generated-data-api-query-dsl)
|
|
48
|
+
* [`trillboards generated generated-data-api-screen-audience-history SCREENID`](#trillboards-generated-generated-data-api-screen-audience-history-screenid)
|
|
49
|
+
* [`trillboards generated generated-data-api-screen-audience-live SCREENID`](#trillboards-generated-generated-data-api-screen-audience-live-screenid)
|
|
50
|
+
* [`trillboards generated generated-data-api-semantic-search`](#trillboards-generated-generated-data-api-semantic-search)
|
|
51
|
+
* [`trillboards generated generated-data-api-stats`](#trillboards-generated-generated-data-api-stats)
|
|
52
|
+
* [`trillboards generated generated-data-api-stream`](#trillboards-generated-generated-data-api-stream)
|
|
53
|
+
* [`trillboards generated generated-data-api-usage`](#trillboards-generated-generated-data-api-usage)
|
|
54
|
+
* [`trillboards generated generated-device-ota-manifest`](#trillboards-generated-generated-device-ota-manifest)
|
|
55
|
+
* [`trillboards generated generated-example-healthcheck`](#trillboards-generated-generated-example-healthcheck)
|
|
56
|
+
* [`trillboards generated generated-playground-dry-run OPERATION_ID`](#trillboards-generated-generated-playground-dry-run-operation_id)
|
|
57
|
+
* [`trillboards generated generated-request-metadata-get REQUEST_ID`](#trillboards-generated-generated-request-metadata-get-request_id)
|
|
58
|
+
* [`trillboards generated generated-sdk-enrich`](#trillboards-generated-generated-sdk-enrich)
|
|
59
|
+
* [`trillboards generated generated-sdk-impression`](#trillboards-generated-generated-sdk-impression)
|
|
60
|
+
* [`trillboards generated generated-sdk-qr-beacon`](#trillboards-generated-generated-sdk-qr-beacon)
|
|
61
|
+
* [`trillboards generated generated-sdk-qr-scan`](#trillboards-generated-generated-sdk-qr-scan)
|
|
62
|
+
* [`trillboards generated generated-sensing-paired-training-upload`](#trillboards-generated-generated-sensing-paired-training-upload)
|
|
63
|
+
* [`trillboards help [COMMAND]`](#trillboards-help-command)
|
|
64
|
+
* [`trillboards listen PORT`](#trillboards-listen-port)
|
|
65
|
+
* [`trillboards login`](#trillboards-login)
|
|
66
|
+
* [`trillboards logs tail`](#trillboards-logs-tail)
|
|
67
|
+
* [`trillboards reconcile`](#trillboards-reconcile)
|
|
68
|
+
* [`trillboards sandbox create`](#trillboards-sandbox-create)
|
|
69
|
+
* [`trillboards sandbox emit EVENT_TYPE`](#trillboards-sandbox-emit-event_type)
|
|
70
|
+
* [`trillboards sandbox reset`](#trillboards-sandbox-reset)
|
|
71
|
+
* [`trillboards sandbox status`](#trillboards-sandbox-status)
|
|
72
|
+
* [`trillboards screens watch`](#trillboards-screens-watch)
|
|
73
|
+
* [`trillboards trigger [EVENT_TYPE]`](#trillboards-trigger-event_type)
|
|
74
|
+
* [`trillboards validate FILE`](#trillboards-validate-file)
|
|
75
|
+
* [`trillboards whoami`](#trillboards-whoami)
|
|
76
|
+
|
|
77
|
+
## `trillboards api METHOD PATH`
|
|
78
|
+
|
|
79
|
+
Make raw API requests (like gh api)
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
USAGE
|
|
83
|
+
$ trillboards api METHOD PATH [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-d
|
|
84
|
+
<value>] [--jq <value>]
|
|
85
|
+
|
|
86
|
+
ARGUMENTS
|
|
87
|
+
METHOD HTTP method (GET, POST, PUT, PATCH, DELETE)
|
|
88
|
+
PATH API path (e.g. /v1/partner/screens)
|
|
89
|
+
|
|
90
|
+
FLAGS
|
|
91
|
+
-d, --data=<value> Request body (JSON string)
|
|
92
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
93
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
94
|
+
--format=<option> Output format
|
|
95
|
+
<options: json|table|yaml>
|
|
96
|
+
--jq=<value> JSON path expression to extract (e.g. "data.items" or "name")
|
|
97
|
+
|
|
98
|
+
DESCRIPTION
|
|
99
|
+
Make raw API requests (like gh api)
|
|
100
|
+
|
|
101
|
+
EXAMPLES
|
|
102
|
+
$ trillboards api GET /v1/partner/screens
|
|
103
|
+
|
|
104
|
+
$ trillboards api POST /v1/partner/device --data '{"name":"test"}'
|
|
105
|
+
|
|
106
|
+
$ trillboards api GET /v1/partner/info --jq partner_name
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
_See code: [src/commands/api.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/api.ts)_
|
|
110
|
+
|
|
111
|
+
## `trillboards audience live SCREEN_ID`
|
|
112
|
+
|
|
113
|
+
Real-time audience sensing data for a screen
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
USAGE
|
|
117
|
+
$ trillboards audience live SCREEN_ID [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
118
|
+
[--interval <value>]
|
|
119
|
+
|
|
120
|
+
ARGUMENTS
|
|
121
|
+
SCREEN_ID Screen ID to monitor
|
|
122
|
+
|
|
123
|
+
FLAGS
|
|
124
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
125
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
126
|
+
--format=<option> Output format
|
|
127
|
+
<options: json|table|yaml>
|
|
128
|
+
--interval=<value> [default: 5] Polling interval in seconds
|
|
129
|
+
|
|
130
|
+
DESCRIPTION
|
|
131
|
+
Real-time audience sensing data for a screen
|
|
132
|
+
|
|
133
|
+
EXAMPLES
|
|
134
|
+
$ trillboards audience live scr_abc123
|
|
135
|
+
|
|
136
|
+
$ trillboards audience live scr_abc123 --format json
|
|
137
|
+
|
|
138
|
+
$ trillboards audience live scr_abc123 --interval 3
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
_See code: [src/commands/audience/live.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/audience/live.ts)_
|
|
142
|
+
|
|
143
|
+
## `trillboards autocomplete [SHELL]`
|
|
144
|
+
|
|
145
|
+
Display autocomplete installation instructions.
|
|
146
|
+
|
|
147
|
+
```
|
|
148
|
+
USAGE
|
|
149
|
+
$ trillboards autocomplete [SHELL] [-r]
|
|
150
|
+
|
|
151
|
+
ARGUMENTS
|
|
152
|
+
[SHELL] (zsh|bash|powershell) Shell type
|
|
153
|
+
|
|
154
|
+
FLAGS
|
|
155
|
+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
156
|
+
|
|
157
|
+
DESCRIPTION
|
|
158
|
+
Display autocomplete installation instructions.
|
|
159
|
+
|
|
160
|
+
EXAMPLES
|
|
161
|
+
$ trillboards autocomplete
|
|
162
|
+
|
|
163
|
+
$ trillboards autocomplete bash
|
|
164
|
+
|
|
165
|
+
$ trillboards autocomplete zsh
|
|
166
|
+
|
|
167
|
+
$ trillboards autocomplete powershell
|
|
168
|
+
|
|
169
|
+
$ trillboards autocomplete --refresh-cache
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.45/src/commands/autocomplete/index.ts)_
|
|
173
|
+
|
|
174
|
+
## `trillboards billing`
|
|
175
|
+
|
|
176
|
+
Billing summary — current plan and usage
|
|
177
|
+
|
|
178
|
+
```
|
|
179
|
+
USAGE
|
|
180
|
+
$ trillboards billing [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
181
|
+
|
|
182
|
+
FLAGS
|
|
183
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
184
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
185
|
+
--format=<option> Output format
|
|
186
|
+
<options: json|table|yaml>
|
|
187
|
+
|
|
188
|
+
DESCRIPTION
|
|
189
|
+
Billing summary — current plan and usage
|
|
190
|
+
|
|
191
|
+
EXAMPLES
|
|
192
|
+
$ trillboards billing
|
|
193
|
+
|
|
194
|
+
$ trillboards billing --format json
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
_See code: [src/commands/billing.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/billing.ts)_
|
|
198
|
+
|
|
199
|
+
## `trillboards billing usage`
|
|
200
|
+
|
|
201
|
+
Billing usage details with optional per-product breakdown
|
|
202
|
+
|
|
203
|
+
```
|
|
204
|
+
USAGE
|
|
205
|
+
$ trillboards billing usage [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--breakdown]
|
|
206
|
+
|
|
207
|
+
FLAGS
|
|
208
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
209
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
210
|
+
--breakdown Show per-product breakdown table
|
|
211
|
+
--format=<option> Output format
|
|
212
|
+
<options: json|table|yaml>
|
|
213
|
+
|
|
214
|
+
DESCRIPTION
|
|
215
|
+
Billing usage details with optional per-product breakdown
|
|
216
|
+
|
|
217
|
+
EXAMPLES
|
|
218
|
+
$ trillboards billing usage
|
|
219
|
+
|
|
220
|
+
$ trillboards billing usage --breakdown
|
|
221
|
+
|
|
222
|
+
$ trillboards billing usage --format json
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
_See code: [src/commands/billing/usage.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/billing/usage.ts)_
|
|
226
|
+
|
|
227
|
+
## `trillboards debug SCREEN_ID`
|
|
228
|
+
|
|
229
|
+
Diagnose a screen — status, performance, audience, issues
|
|
230
|
+
|
|
231
|
+
```
|
|
232
|
+
USAGE
|
|
233
|
+
$ trillboards debug SCREEN_ID [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
234
|
+
|
|
235
|
+
ARGUMENTS
|
|
236
|
+
SCREEN_ID Screen ID to diagnose
|
|
237
|
+
|
|
238
|
+
FLAGS
|
|
239
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
240
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
241
|
+
--format=<option> Output format
|
|
242
|
+
<options: json|table|yaml>
|
|
243
|
+
|
|
244
|
+
DESCRIPTION
|
|
245
|
+
Diagnose a screen — status, performance, audience, issues
|
|
246
|
+
|
|
247
|
+
EXAMPLES
|
|
248
|
+
$ trillboards debug scr_abc123
|
|
249
|
+
|
|
250
|
+
$ trillboards debug scr_abc123 --format json
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
_See code: [src/commands/debug.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/debug.ts)_
|
|
254
|
+
|
|
255
|
+
## `trillboards doctor`
|
|
256
|
+
|
|
257
|
+
Run system diagnostics and check API connectivity
|
|
258
|
+
|
|
259
|
+
```
|
|
260
|
+
USAGE
|
|
261
|
+
$ trillboards doctor [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
262
|
+
|
|
263
|
+
FLAGS
|
|
264
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
265
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
266
|
+
--format=<option> Output format
|
|
267
|
+
<options: json|table|yaml>
|
|
268
|
+
|
|
269
|
+
DESCRIPTION
|
|
270
|
+
Run system diagnostics and check API connectivity
|
|
271
|
+
|
|
272
|
+
EXAMPLES
|
|
273
|
+
$ trillboards doctor
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
_See code: [src/commands/doctor.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/doctor.ts)_
|
|
277
|
+
|
|
278
|
+
## `trillboards earnings [MODE]`
|
|
279
|
+
|
|
280
|
+
Revenue dashboard — today's summary, historical charts, or live streaming
|
|
281
|
+
|
|
282
|
+
```
|
|
283
|
+
USAGE
|
|
284
|
+
$ trillboards earnings [MODE] [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--period
|
|
285
|
+
<value>]
|
|
286
|
+
|
|
287
|
+
ARGUMENTS
|
|
288
|
+
[MODE] (live) Mode: "live" for real-time streaming
|
|
289
|
+
|
|
290
|
+
FLAGS
|
|
291
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
292
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
293
|
+
--format=<option> Output format
|
|
294
|
+
<options: json|table|yaml>
|
|
295
|
+
--period=<value> [default: 1d] Time period (e.g. 1d, 7d, 30d)
|
|
296
|
+
|
|
297
|
+
DESCRIPTION
|
|
298
|
+
Revenue dashboard — today's summary, historical charts, or live streaming
|
|
299
|
+
|
|
300
|
+
EXAMPLES
|
|
301
|
+
$ trillboards earnings
|
|
302
|
+
|
|
303
|
+
$ trillboards earnings --period 30d
|
|
304
|
+
|
|
305
|
+
$ trillboards earnings live
|
|
306
|
+
|
|
307
|
+
$ trillboards earnings --format json
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
_See code: [src/commands/earnings.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/earnings.ts)_
|
|
311
|
+
|
|
312
|
+
## `trillboards endpoints`
|
|
313
|
+
|
|
314
|
+
Discover available API endpoints
|
|
315
|
+
|
|
316
|
+
```
|
|
317
|
+
USAGE
|
|
318
|
+
$ trillboards endpoints [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-s <value>]
|
|
319
|
+
|
|
320
|
+
FLAGS
|
|
321
|
+
-s, --search=<value> Search query to filter endpoints
|
|
322
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
323
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
324
|
+
--format=<option> Output format
|
|
325
|
+
<options: json|table|yaml>
|
|
326
|
+
|
|
327
|
+
DESCRIPTION
|
|
328
|
+
Discover available API endpoints
|
|
329
|
+
|
|
330
|
+
EXAMPLES
|
|
331
|
+
$ trillboards endpoints
|
|
332
|
+
|
|
333
|
+
$ trillboards endpoints --search screens
|
|
334
|
+
|
|
335
|
+
$ trillboards endpoints --format json
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
_See code: [src/commands/endpoints/index.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/endpoints/index.ts)_
|
|
339
|
+
|
|
340
|
+
## `trillboards errors [CODE]`
|
|
341
|
+
|
|
342
|
+
Look up error codes from the error catalog
|
|
343
|
+
|
|
344
|
+
```
|
|
345
|
+
USAGE
|
|
346
|
+
$ trillboards errors [CODE] [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
347
|
+
|
|
348
|
+
ARGUMENTS
|
|
349
|
+
[CODE] Error code to look up (e.g. screen_not_found)
|
|
350
|
+
|
|
351
|
+
FLAGS
|
|
352
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
353
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
354
|
+
--format=<option> Output format
|
|
355
|
+
<options: json|table|yaml>
|
|
356
|
+
|
|
357
|
+
DESCRIPTION
|
|
358
|
+
Look up error codes from the error catalog
|
|
359
|
+
|
|
360
|
+
EXAMPLES
|
|
361
|
+
$ trillboards errors
|
|
362
|
+
|
|
363
|
+
$ trillboards errors screen_not_found
|
|
364
|
+
|
|
365
|
+
$ trillboards errors --format json
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
_See code: [src/commands/errors/index.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/errors/index.ts)_
|
|
369
|
+
|
|
370
|
+
## `trillboards fill-rate`
|
|
371
|
+
|
|
372
|
+
Fill rate analysis — overall, per-screen, or by time
|
|
373
|
+
|
|
374
|
+
```
|
|
375
|
+
USAGE
|
|
376
|
+
$ trillboards fill-rate [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--by
|
|
377
|
+
partner|screen|hour]
|
|
378
|
+
|
|
379
|
+
FLAGS
|
|
380
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
381
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
382
|
+
--by=<option> Breakdown dimension
|
|
383
|
+
<options: partner|screen|hour>
|
|
384
|
+
--format=<option> Output format
|
|
385
|
+
<options: json|table|yaml>
|
|
386
|
+
|
|
387
|
+
DESCRIPTION
|
|
388
|
+
Fill rate analysis — overall, per-screen, or by time
|
|
389
|
+
|
|
390
|
+
EXAMPLES
|
|
391
|
+
$ trillboards fill-rate
|
|
392
|
+
|
|
393
|
+
$ trillboards fill-rate --by screen
|
|
394
|
+
|
|
395
|
+
$ trillboards fill-rate --by hour
|
|
396
|
+
|
|
397
|
+
$ trillboards fill-rate --format json
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
_See code: [src/commands/fill-rate.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/fill-rate.ts)_
|
|
401
|
+
|
|
402
|
+
## `trillboards generated generated-changelog-query`
|
|
403
|
+
|
|
404
|
+
Query API changelog
|
|
405
|
+
|
|
406
|
+
```
|
|
407
|
+
USAGE
|
|
408
|
+
$ trillboards generated generated-changelog-query [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--since <value>]
|
|
409
|
+
[--type <value>]
|
|
410
|
+
|
|
411
|
+
FLAGS
|
|
412
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
413
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
414
|
+
--format=<option> Output format
|
|
415
|
+
<options: json|table|yaml>
|
|
416
|
+
--since=<value> Only entries dated on or after this date (YYYY-MM-DD). Unreleased entries always included.
|
|
417
|
+
--type=<value> Filter by change category: "breaking" (changed+removed), "additive" (added), "deprecation"
|
|
418
|
+
(deprecated), "fix" (fixed). Comma-separated for multiple.
|
|
419
|
+
|
|
420
|
+
DESCRIPTION
|
|
421
|
+
Query API changelog
|
|
422
|
+
|
|
423
|
+
EXAMPLES
|
|
424
|
+
$ trillboards generated changelog query
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
_See code: [src/commands/generated/generated-changelog-query.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-changelog-query.ts)_
|
|
428
|
+
|
|
429
|
+
## `trillboards generated generated-data-api-aggregate`
|
|
430
|
+
|
|
431
|
+
Aggregate audience analytics for a time window.
|
|
432
|
+
|
|
433
|
+
```
|
|
434
|
+
USAGE
|
|
435
|
+
$ trillboards generated generated-data-api-aggregate [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--group_by
|
|
436
|
+
<value>] [--metric <value>] [--since <value>]
|
|
437
|
+
|
|
438
|
+
FLAGS
|
|
439
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
440
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
441
|
+
--format=<option> Output format
|
|
442
|
+
<options: json|table|yaml>
|
|
443
|
+
--group_by=<value> Dimension to group aggregations by.
|
|
444
|
+
--metric=<value> Metric to aggregate on.
|
|
445
|
+
--since=<value> Relative time window (e.g. "24h", "7d").
|
|
446
|
+
|
|
447
|
+
DESCRIPTION
|
|
448
|
+
Aggregate audience analytics for a time window.
|
|
449
|
+
|
|
450
|
+
EXAMPLES
|
|
451
|
+
$ trillboards generated data-api-aggregate
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
_See code: [src/commands/generated/generated-data-api-aggregate.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-aggregate.ts)_
|
|
455
|
+
|
|
456
|
+
## `trillboards generated generated-data-api-list-screens`
|
|
457
|
+
|
|
458
|
+
List screens visible to the caller.
|
|
459
|
+
|
|
460
|
+
```
|
|
461
|
+
USAGE
|
|
462
|
+
$ trillboards generated generated-data-api-list-screens [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--limit <value>]
|
|
463
|
+
[--offset <value>] [--venue_type <value>] [--country <value>]
|
|
464
|
+
|
|
465
|
+
FLAGS
|
|
466
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
467
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
468
|
+
--country=<value> ISO-3166 alpha-2 country code.
|
|
469
|
+
--format=<option> Output format
|
|
470
|
+
<options: json|table|yaml>
|
|
471
|
+
--limit=<value> limit
|
|
472
|
+
--offset=<value> offset
|
|
473
|
+
--venue_type=<value> Filter by venue taxonomy type (e.g. bar, restaurant).
|
|
474
|
+
|
|
475
|
+
DESCRIPTION
|
|
476
|
+
List screens visible to the caller.
|
|
477
|
+
|
|
478
|
+
EXAMPLES
|
|
479
|
+
$ trillboards generated data-api-list-screens
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
_See code: [src/commands/generated/generated-data-api-list-screens.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-list-screens.ts)_
|
|
483
|
+
|
|
484
|
+
## `trillboards generated generated-data-api-lookalike-screens`
|
|
485
|
+
|
|
486
|
+
Find screens with similar audience profiles.
|
|
487
|
+
|
|
488
|
+
```
|
|
489
|
+
USAGE
|
|
490
|
+
$ trillboards generated generated-data-api-lookalike-screens [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--screen_id
|
|
491
|
+
<value>] [--limit <value>] [--min_similarity <value>]
|
|
492
|
+
|
|
493
|
+
FLAGS
|
|
494
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
495
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
496
|
+
--format=<option> Output format
|
|
497
|
+
<options: json|table|yaml>
|
|
498
|
+
--limit=<value> limit
|
|
499
|
+
--min_similarity=<value> min_similarity
|
|
500
|
+
--screen_id=<value> Internal screen identifier.
|
|
501
|
+
|
|
502
|
+
DESCRIPTION
|
|
503
|
+
Find screens with similar audience profiles.
|
|
504
|
+
|
|
505
|
+
EXAMPLES
|
|
506
|
+
$ trillboards generated data-api-lookalike-screens
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
_See code: [src/commands/generated/generated-data-api-lookalike-screens.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-lookalike-screens.ts)_
|
|
510
|
+
|
|
511
|
+
## `trillboards generated generated-data-api-query-dsl`
|
|
512
|
+
|
|
513
|
+
Composable query DSL over approved datasets.
|
|
514
|
+
|
|
515
|
+
```
|
|
516
|
+
USAGE
|
|
517
|
+
$ trillboards generated generated-data-api-query-dsl [--api-key <value>] [--base-url <value>] [--format
|
|
518
|
+
json|table|yaml] [--data <value>]
|
|
519
|
+
|
|
520
|
+
FLAGS
|
|
521
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
522
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
523
|
+
--data=<value> JSON request body
|
|
524
|
+
--format=<option> Output format
|
|
525
|
+
<options: json|table|yaml>
|
|
526
|
+
|
|
527
|
+
DESCRIPTION
|
|
528
|
+
Composable query DSL over approved datasets.
|
|
529
|
+
|
|
530
|
+
EXAMPLES
|
|
531
|
+
$ trillboards generated data-api-query-dsl
|
|
532
|
+
```
|
|
533
|
+
|
|
534
|
+
_See code: [src/commands/generated/generated-data-api-query-dsl.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-query-dsl.ts)_
|
|
535
|
+
|
|
536
|
+
## `trillboards generated generated-data-api-screen-audience-history SCREENID`
|
|
537
|
+
|
|
538
|
+
Historical audience_metrics rows for a screen.
|
|
539
|
+
|
|
540
|
+
```
|
|
541
|
+
USAGE
|
|
542
|
+
$ trillboards generated generated-data-api-screen-audience-history SCREENID [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--since
|
|
543
|
+
<value>] [--until <value>] [--limit <value>]
|
|
544
|
+
|
|
545
|
+
ARGUMENTS
|
|
546
|
+
SCREENID Internal screen identifier.
|
|
547
|
+
|
|
548
|
+
FLAGS
|
|
549
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
550
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
551
|
+
--format=<option> Output format
|
|
552
|
+
<options: json|table|yaml>
|
|
553
|
+
--limit=<value> limit
|
|
554
|
+
--since=<value> ISO-8601 start timestamp.
|
|
555
|
+
--until=<value> ISO-8601 end timestamp.
|
|
556
|
+
|
|
557
|
+
DESCRIPTION
|
|
558
|
+
Historical audience_metrics rows for a screen.
|
|
559
|
+
|
|
560
|
+
EXAMPLES
|
|
561
|
+
$ trillboards generated data-api-screen-audience-history
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
_See code: [src/commands/generated/generated-data-api-screen-audience-history.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-screen-audience-history.ts)_
|
|
565
|
+
|
|
566
|
+
## `trillboards generated generated-data-api-screen-audience-live SCREENID`
|
|
567
|
+
|
|
568
|
+
Real-time audience snapshot for a screen.
|
|
569
|
+
|
|
570
|
+
```
|
|
571
|
+
USAGE
|
|
572
|
+
$ trillboards generated generated-data-api-screen-audience-live SCREENID [--api-key <value>] [--base-url <value>]
|
|
573
|
+
[--format json|table|yaml]
|
|
574
|
+
|
|
575
|
+
ARGUMENTS
|
|
576
|
+
SCREENID Internal screen identifier.
|
|
577
|
+
|
|
578
|
+
FLAGS
|
|
579
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
580
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
581
|
+
--format=<option> Output format
|
|
582
|
+
<options: json|table|yaml>
|
|
583
|
+
|
|
584
|
+
DESCRIPTION
|
|
585
|
+
Real-time audience snapshot for a screen.
|
|
586
|
+
|
|
587
|
+
EXAMPLES
|
|
588
|
+
$ trillboards generated data-api-screen-audience-live
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
_See code: [src/commands/generated/generated-data-api-screen-audience-live.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-screen-audience-live.ts)_
|
|
592
|
+
|
|
593
|
+
## `trillboards generated generated-data-api-semantic-search`
|
|
594
|
+
|
|
595
|
+
Similarity search over scene embeddings.
|
|
596
|
+
|
|
597
|
+
```
|
|
598
|
+
USAGE
|
|
599
|
+
$ trillboards generated generated-data-api-semantic-search [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--q <value>]
|
|
600
|
+
[--limit <value>] [--since <value>] [--min_similarity <value>]
|
|
601
|
+
|
|
602
|
+
FLAGS
|
|
603
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
604
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
605
|
+
--format=<option> Output format
|
|
606
|
+
<options: json|table|yaml>
|
|
607
|
+
--limit=<value> limit
|
|
608
|
+
--min_similarity=<value> min_similarity
|
|
609
|
+
--q=<value> q
|
|
610
|
+
--since=<value> Relative time window (e.g. "24h", "7d").
|
|
611
|
+
|
|
612
|
+
DESCRIPTION
|
|
613
|
+
Similarity search over scene embeddings.
|
|
614
|
+
|
|
615
|
+
EXAMPLES
|
|
616
|
+
$ trillboards generated data-api-semantic-search
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
_See code: [src/commands/generated/generated-data-api-semantic-search.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-semantic-search.ts)_
|
|
620
|
+
|
|
621
|
+
## `trillboards generated generated-data-api-stats`
|
|
622
|
+
|
|
623
|
+
Platform-wide counters.
|
|
624
|
+
|
|
625
|
+
```
|
|
626
|
+
USAGE
|
|
627
|
+
$ trillboards generated generated-data-api-stats [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
628
|
+
|
|
629
|
+
FLAGS
|
|
630
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
631
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
632
|
+
--format=<option> Output format
|
|
633
|
+
<options: json|table|yaml>
|
|
634
|
+
|
|
635
|
+
DESCRIPTION
|
|
636
|
+
Platform-wide counters.
|
|
637
|
+
|
|
638
|
+
EXAMPLES
|
|
639
|
+
$ trillboards generated data-api-stats
|
|
640
|
+
```
|
|
641
|
+
|
|
642
|
+
_See code: [src/commands/generated/generated-data-api-stats.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-stats.ts)_
|
|
643
|
+
|
|
644
|
+
## `trillboards generated generated-data-api-stream`
|
|
645
|
+
|
|
646
|
+
Server-Sent Events stream of live audience/observation events.
|
|
647
|
+
|
|
648
|
+
```
|
|
649
|
+
USAGE
|
|
650
|
+
$ trillboards generated generated-data-api-stream [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
651
|
+
[--observation_family <value>] [--venue_type <value>]
|
|
652
|
+
|
|
653
|
+
FLAGS
|
|
654
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
655
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
656
|
+
--format=<option> Output format
|
|
657
|
+
<options: json|table|yaml>
|
|
658
|
+
--observation_family=<value> observation_family
|
|
659
|
+
--venue_type=<value> venue_type
|
|
660
|
+
|
|
661
|
+
DESCRIPTION
|
|
662
|
+
Server-Sent Events stream of live audience/observation events.
|
|
663
|
+
|
|
664
|
+
EXAMPLES
|
|
665
|
+
$ trillboards generated data-api-stream
|
|
666
|
+
```
|
|
667
|
+
|
|
668
|
+
_See code: [src/commands/generated/generated-data-api-stream.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-stream.ts)_
|
|
669
|
+
|
|
670
|
+
## `trillboards generated generated-data-api-usage`
|
|
671
|
+
|
|
672
|
+
API usage for the authenticated key (billing dashboard).
|
|
673
|
+
|
|
674
|
+
```
|
|
675
|
+
USAGE
|
|
676
|
+
$ trillboards generated generated-data-api-usage [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
677
|
+
[--days <value>]
|
|
678
|
+
|
|
679
|
+
FLAGS
|
|
680
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
681
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
682
|
+
--days=<value> days
|
|
683
|
+
--format=<option> Output format
|
|
684
|
+
<options: json|table|yaml>
|
|
685
|
+
|
|
686
|
+
DESCRIPTION
|
|
687
|
+
API usage for the authenticated key (billing dashboard).
|
|
688
|
+
|
|
689
|
+
EXAMPLES
|
|
690
|
+
$ trillboards generated data-api-usage
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
_See code: [src/commands/generated/generated-data-api-usage.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-data-api-usage.ts)_
|
|
694
|
+
|
|
695
|
+
## `trillboards generated generated-device-ota-manifest`
|
|
696
|
+
|
|
697
|
+
Signed OTA manifest for managed-device update clients.
|
|
698
|
+
|
|
699
|
+
```
|
|
700
|
+
USAGE
|
|
701
|
+
$ trillboards generated generated-device-ota-manifest [--api-key <value>] [--base-url <value>] [--format
|
|
702
|
+
json|table|yaml] [--agent <value>]
|
|
703
|
+
|
|
704
|
+
FLAGS
|
|
705
|
+
--agent=<value> Optional agent type filter (`agent-core`, `agent-core-lite`, etc.). When omitted the caller
|
|
706
|
+
receives the default manifest bundle.
|
|
707
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
708
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
709
|
+
--format=<option> Output format
|
|
710
|
+
<options: json|table|yaml>
|
|
711
|
+
|
|
712
|
+
DESCRIPTION
|
|
713
|
+
Signed OTA manifest for managed-device update clients.
|
|
714
|
+
|
|
715
|
+
EXAMPLES
|
|
716
|
+
$ trillboards generated device-ota-manifest
|
|
717
|
+
```
|
|
718
|
+
|
|
719
|
+
_See code: [src/commands/generated/generated-device-ota-manifest.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-device-ota-manifest.ts)_
|
|
720
|
+
|
|
721
|
+
## `trillboards generated generated-example-healthcheck`
|
|
722
|
+
|
|
723
|
+
Example healthcheck (Phase 3 pipeline proof)
|
|
724
|
+
|
|
725
|
+
```
|
|
726
|
+
USAGE
|
|
727
|
+
$ trillboards generated generated-example-healthcheck [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--verbose
|
|
728
|
+
<value>]
|
|
729
|
+
|
|
730
|
+
FLAGS
|
|
731
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
732
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
733
|
+
--format=<option> Output format
|
|
734
|
+
<options: json|table|yaml>
|
|
735
|
+
--verbose=<value> When `true`, include diagnostic fields in the response.
|
|
736
|
+
|
|
737
|
+
DESCRIPTION
|
|
738
|
+
Example healthcheck (Phase 3 pipeline proof)
|
|
739
|
+
|
|
740
|
+
EXAMPLES
|
|
741
|
+
$ trillboards generated example-healthcheck
|
|
742
|
+
```
|
|
743
|
+
|
|
744
|
+
_See code: [src/commands/generated/generated-example-healthcheck.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-example-healthcheck.ts)_
|
|
745
|
+
|
|
746
|
+
## `trillboards generated generated-playground-dry-run OPERATION_ID`
|
|
747
|
+
|
|
748
|
+
Dry-run validate a request body against an operation schema
|
|
749
|
+
|
|
750
|
+
```
|
|
751
|
+
USAGE
|
|
752
|
+
$ trillboards generated generated-playground-dry-run OPERATION_ID [--api-key <value>] [--base-url <value>] [--format
|
|
753
|
+
json|table|yaml]
|
|
754
|
+
|
|
755
|
+
ARGUMENTS
|
|
756
|
+
OPERATION_ID The operationId of the endpoint to validate against.
|
|
757
|
+
|
|
758
|
+
FLAGS
|
|
759
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
760
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
761
|
+
--format=<option> Output format
|
|
762
|
+
<options: json|table|yaml>
|
|
763
|
+
|
|
764
|
+
DESCRIPTION
|
|
765
|
+
Dry-run validate a request body against an operation schema
|
|
766
|
+
|
|
767
|
+
EXAMPLES
|
|
768
|
+
$ trillboards generated playground-dry-run
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
_See code: [src/commands/generated/generated-playground-dry-run.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-playground-dry-run.ts)_
|
|
772
|
+
|
|
773
|
+
## `trillboards generated generated-request-metadata-get REQUEST_ID`
|
|
774
|
+
|
|
775
|
+
Look up metadata for a recent API request
|
|
776
|
+
|
|
777
|
+
```
|
|
778
|
+
USAGE
|
|
779
|
+
$ trillboards generated generated-request-metadata-get REQUEST_ID [--api-key <value>] [--base-url <value>] [--format
|
|
780
|
+
json|table|yaml]
|
|
781
|
+
|
|
782
|
+
ARGUMENTS
|
|
783
|
+
REQUEST_ID Server-generated request ID to look up.
|
|
784
|
+
|
|
785
|
+
FLAGS
|
|
786
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
787
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
788
|
+
--format=<option> Output format
|
|
789
|
+
<options: json|table|yaml>
|
|
790
|
+
|
|
791
|
+
DESCRIPTION
|
|
792
|
+
Look up metadata for a recent API request
|
|
793
|
+
|
|
794
|
+
EXAMPLES
|
|
795
|
+
$ trillboards generated request-metadata get
|
|
796
|
+
```
|
|
797
|
+
|
|
798
|
+
_See code: [src/commands/generated/generated-request-metadata-get.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-request-metadata-get.ts)_
|
|
799
|
+
|
|
800
|
+
## `trillboards generated generated-sdk-enrich`
|
|
801
|
+
|
|
802
|
+
Census + demographic enrichment from the request IP.
|
|
803
|
+
|
|
804
|
+
```
|
|
805
|
+
USAGE
|
|
806
|
+
$ trillboards generated generated-sdk-enrich [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
807
|
+
[--data <value>]
|
|
808
|
+
|
|
809
|
+
FLAGS
|
|
810
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
811
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
812
|
+
--data=<value> JSON request body
|
|
813
|
+
--format=<option> Output format
|
|
814
|
+
<options: json|table|yaml>
|
|
815
|
+
|
|
816
|
+
DESCRIPTION
|
|
817
|
+
Census + demographic enrichment from the request IP.
|
|
818
|
+
|
|
819
|
+
EXAMPLES
|
|
820
|
+
$ trillboards generated sdk-enrich
|
|
821
|
+
```
|
|
822
|
+
|
|
823
|
+
_See code: [src/commands/generated/generated-sdk-enrich.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-sdk-enrich.ts)_
|
|
824
|
+
|
|
825
|
+
## `trillboards generated generated-sdk-impression`
|
|
826
|
+
|
|
827
|
+
Ingest an enriched CTV/DOOH impression.
|
|
828
|
+
|
|
829
|
+
```
|
|
830
|
+
USAGE
|
|
831
|
+
$ trillboards generated generated-sdk-impression [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
832
|
+
[--data <value>]
|
|
833
|
+
|
|
834
|
+
FLAGS
|
|
835
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
836
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
837
|
+
--data=<value> JSON request body
|
|
838
|
+
--format=<option> Output format
|
|
839
|
+
<options: json|table|yaml>
|
|
840
|
+
|
|
841
|
+
DESCRIPTION
|
|
842
|
+
Ingest an enriched CTV/DOOH impression.
|
|
843
|
+
|
|
844
|
+
EXAMPLES
|
|
845
|
+
$ trillboards generated sdk-impression
|
|
846
|
+
```
|
|
847
|
+
|
|
848
|
+
_See code: [src/commands/generated/generated-sdk-impression.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-sdk-impression.ts)_
|
|
849
|
+
|
|
850
|
+
## `trillboards generated generated-sdk-qr-beacon`
|
|
851
|
+
|
|
852
|
+
Process beacon signals associated with a prior QR scan.
|
|
853
|
+
|
|
854
|
+
```
|
|
855
|
+
USAGE
|
|
856
|
+
$ trillboards generated generated-sdk-qr-beacon [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
857
|
+
[--data <value>]
|
|
858
|
+
|
|
859
|
+
FLAGS
|
|
860
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
861
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
862
|
+
--data=<value> JSON request body
|
|
863
|
+
--format=<option> Output format
|
|
864
|
+
<options: json|table|yaml>
|
|
865
|
+
|
|
866
|
+
DESCRIPTION
|
|
867
|
+
Process beacon signals associated with a prior QR scan.
|
|
868
|
+
|
|
869
|
+
EXAMPLES
|
|
870
|
+
$ trillboards generated sdk-qr-beacon
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
_See code: [src/commands/generated/generated-sdk-qr-beacon.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-sdk-qr-beacon.ts)_
|
|
874
|
+
|
|
875
|
+
## `trillboards generated generated-sdk-qr-scan`
|
|
876
|
+
|
|
877
|
+
Record a QR-code scan for physical-to-digital attribution.
|
|
878
|
+
|
|
879
|
+
```
|
|
880
|
+
USAGE
|
|
881
|
+
$ trillboards generated generated-sdk-qr-scan [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
882
|
+
[--data <value>]
|
|
883
|
+
|
|
884
|
+
FLAGS
|
|
885
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
886
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
887
|
+
--data=<value> JSON request body
|
|
888
|
+
--format=<option> Output format
|
|
889
|
+
<options: json|table|yaml>
|
|
890
|
+
|
|
891
|
+
DESCRIPTION
|
|
892
|
+
Record a QR-code scan for physical-to-digital attribution.
|
|
893
|
+
|
|
894
|
+
EXAMPLES
|
|
895
|
+
$ trillboards generated sdk-qr-scan
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
_See code: [src/commands/generated/generated-sdk-qr-scan.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-sdk-qr-scan.ts)_
|
|
899
|
+
|
|
900
|
+
## `trillboards generated generated-sensing-paired-training-upload`
|
|
901
|
+
|
|
902
|
+
Upload a batch of paired camera/CSI training samples.
|
|
903
|
+
|
|
904
|
+
```
|
|
905
|
+
USAGE
|
|
906
|
+
$ trillboards generated generated-sensing-paired-training-upload [--api-key <value>] [--base-url <value>] [--format
|
|
907
|
+
json|table|yaml] [--data <value>]
|
|
908
|
+
|
|
909
|
+
FLAGS
|
|
910
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
911
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
912
|
+
--data=<value> JSON request body
|
|
913
|
+
--format=<option> Output format
|
|
914
|
+
<options: json|table|yaml>
|
|
915
|
+
|
|
916
|
+
DESCRIPTION
|
|
917
|
+
Upload a batch of paired camera/CSI training samples.
|
|
918
|
+
|
|
919
|
+
EXAMPLES
|
|
920
|
+
$ trillboards generated sensing-paired-training-upload
|
|
921
|
+
```
|
|
922
|
+
|
|
923
|
+
_See code: [src/commands/generated/generated-sensing-paired-training-upload.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/generated/generated-sensing-paired-training-upload.ts)_
|
|
924
|
+
|
|
925
|
+
## `trillboards help [COMMAND]`
|
|
926
|
+
|
|
927
|
+
Display help for trillboards.
|
|
928
|
+
|
|
929
|
+
```
|
|
930
|
+
USAGE
|
|
931
|
+
$ trillboards help [COMMAND...] [-n]
|
|
932
|
+
|
|
933
|
+
ARGUMENTS
|
|
934
|
+
[COMMAND...] Command to show help for.
|
|
935
|
+
|
|
936
|
+
FLAGS
|
|
937
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
938
|
+
|
|
939
|
+
DESCRIPTION
|
|
940
|
+
Display help for trillboards.
|
|
941
|
+
```
|
|
942
|
+
|
|
943
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.44/src/commands/help.ts)_
|
|
944
|
+
|
|
945
|
+
## `trillboards listen PORT`
|
|
946
|
+
|
|
947
|
+
Forward live SSE events to a local HTTP server (webhook dev loop)
|
|
948
|
+
|
|
949
|
+
```
|
|
950
|
+
USAGE
|
|
951
|
+
$ trillboards listen PORT [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--events
|
|
952
|
+
<value>] [--path <value>]
|
|
953
|
+
|
|
954
|
+
ARGUMENTS
|
|
955
|
+
PORT Local port to forward webhook events to
|
|
956
|
+
|
|
957
|
+
FLAGS
|
|
958
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
959
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
960
|
+
--events=<value> [default: *] Comma-separated SSE event types to subscribe to ("*" = all)
|
|
961
|
+
--format=<option> Output format
|
|
962
|
+
<options: json|table|yaml>
|
|
963
|
+
--path=<value> [default: /webhook] HTTP path on the local server to POST events to
|
|
964
|
+
|
|
965
|
+
DESCRIPTION
|
|
966
|
+
Forward live SSE events to a local HTTP server (webhook dev loop)
|
|
967
|
+
|
|
968
|
+
EXAMPLES
|
|
969
|
+
$ trillboards listen 3000
|
|
970
|
+
|
|
971
|
+
$ trillboards listen 3000 --path /hooks
|
|
972
|
+
|
|
973
|
+
$ trillboards listen 4000 --events request.logged,error.occurred
|
|
974
|
+
```
|
|
975
|
+
|
|
976
|
+
_See code: [src/commands/listen.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/listen.ts)_
|
|
977
|
+
|
|
978
|
+
## `trillboards login`
|
|
979
|
+
|
|
980
|
+
Authenticate with the Trillboards API
|
|
981
|
+
|
|
982
|
+
```
|
|
983
|
+
USAGE
|
|
984
|
+
$ trillboards login [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
985
|
+
|
|
986
|
+
FLAGS
|
|
987
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
988
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
989
|
+
--format=<option> Output format
|
|
990
|
+
<options: json|table|yaml>
|
|
991
|
+
|
|
992
|
+
DESCRIPTION
|
|
993
|
+
Authenticate with the Trillboards API
|
|
994
|
+
|
|
995
|
+
EXAMPLES
|
|
996
|
+
$ trillboards login
|
|
997
|
+
|
|
998
|
+
TRILLBOARDS_API_KEY=trb_partner_xxx trillboards login
|
|
999
|
+
```
|
|
1000
|
+
|
|
1001
|
+
_See code: [src/commands/login.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/login.ts)_
|
|
1002
|
+
|
|
1003
|
+
## `trillboards logs tail`
|
|
1004
|
+
|
|
1005
|
+
Tail real-time request logs via server-sent events
|
|
1006
|
+
|
|
1007
|
+
```
|
|
1008
|
+
USAGE
|
|
1009
|
+
$ trillboards logs tail [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--events
|
|
1010
|
+
<value>] [--status <value>]
|
|
1011
|
+
|
|
1012
|
+
FLAGS
|
|
1013
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1014
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1015
|
+
--events=<value> [default: request.logged,error.occurred] Comma-separated SSE event types to subscribe to
|
|
1016
|
+
--format=<option> Output format
|
|
1017
|
+
<options: json|table|yaml>
|
|
1018
|
+
--status=<value> Filter by status code pattern (e.g. "4xx", "5xx", "4xx,5xx", "404")
|
|
1019
|
+
|
|
1020
|
+
DESCRIPTION
|
|
1021
|
+
Tail real-time request logs via server-sent events
|
|
1022
|
+
|
|
1023
|
+
EXAMPLES
|
|
1024
|
+
$ trillboards logs tail
|
|
1025
|
+
|
|
1026
|
+
$ trillboards logs tail --events error.occurred
|
|
1027
|
+
|
|
1028
|
+
$ trillboards logs tail --status 4xx,5xx
|
|
1029
|
+
|
|
1030
|
+
$ trillboards logs tail --events request.logged,error.occurred --status 5xx
|
|
1031
|
+
```
|
|
1032
|
+
|
|
1033
|
+
_See code: [src/commands/logs/tail.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/logs/tail.ts)_
|
|
1034
|
+
|
|
1035
|
+
## `trillboards reconcile`
|
|
1036
|
+
|
|
1037
|
+
Revenue reconciliation — compare our numbers with partner reports
|
|
1038
|
+
|
|
1039
|
+
```
|
|
1040
|
+
USAGE
|
|
1041
|
+
$ trillboards reconcile [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--period <value>]
|
|
1042
|
+
|
|
1043
|
+
FLAGS
|
|
1044
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1045
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1046
|
+
--format=<option> Output format
|
|
1047
|
+
<options: json|table|yaml>
|
|
1048
|
+
--period=<value> [default: 30d] Time period for reconciliation (e.g. 7d, 30d)
|
|
1049
|
+
|
|
1050
|
+
DESCRIPTION
|
|
1051
|
+
Revenue reconciliation — compare our numbers with partner reports
|
|
1052
|
+
|
|
1053
|
+
EXAMPLES
|
|
1054
|
+
$ trillboards reconcile
|
|
1055
|
+
|
|
1056
|
+
$ trillboards reconcile --period 7d
|
|
1057
|
+
|
|
1058
|
+
$ trillboards reconcile --format json
|
|
1059
|
+
```
|
|
1060
|
+
|
|
1061
|
+
_See code: [src/commands/reconcile.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/reconcile.ts)_
|
|
1062
|
+
|
|
1063
|
+
## `trillboards sandbox create`
|
|
1064
|
+
|
|
1065
|
+
Create a sandbox test screen
|
|
1066
|
+
|
|
1067
|
+
```
|
|
1068
|
+
USAGE
|
|
1069
|
+
$ trillboards sandbox create [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
1070
|
+
|
|
1071
|
+
FLAGS
|
|
1072
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1073
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1074
|
+
--format=<option> Output format
|
|
1075
|
+
<options: json|table|yaml>
|
|
1076
|
+
|
|
1077
|
+
DESCRIPTION
|
|
1078
|
+
Create a sandbox test screen
|
|
1079
|
+
|
|
1080
|
+
EXAMPLES
|
|
1081
|
+
$ trillboards sandbox create
|
|
1082
|
+
|
|
1083
|
+
$ trillboards sandbox create --format json
|
|
1084
|
+
```
|
|
1085
|
+
|
|
1086
|
+
_See code: [src/commands/sandbox/create.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/sandbox/create.ts)_
|
|
1087
|
+
|
|
1088
|
+
## `trillboards sandbox emit EVENT_TYPE`
|
|
1089
|
+
|
|
1090
|
+
Emit a test event in the sandbox
|
|
1091
|
+
|
|
1092
|
+
```
|
|
1093
|
+
USAGE
|
|
1094
|
+
$ trillboards sandbox emit EVENT_TYPE [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-d
|
|
1095
|
+
<value>]
|
|
1096
|
+
|
|
1097
|
+
ARGUMENTS
|
|
1098
|
+
EVENT_TYPE Event type to emit (e.g. impression.recorded, heartbeat)
|
|
1099
|
+
|
|
1100
|
+
FLAGS
|
|
1101
|
+
-d, --data=<value> Additional event data (JSON string)
|
|
1102
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1103
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1104
|
+
--format=<option> Output format
|
|
1105
|
+
<options: json|table|yaml>
|
|
1106
|
+
|
|
1107
|
+
DESCRIPTION
|
|
1108
|
+
Emit a test event in the sandbox
|
|
1109
|
+
|
|
1110
|
+
EXAMPLES
|
|
1111
|
+
$ trillboards sandbox emit impression.recorded
|
|
1112
|
+
|
|
1113
|
+
$ trillboards sandbox emit heartbeat
|
|
1114
|
+
|
|
1115
|
+
$ trillboards sandbox emit impression.recorded --data '{"cpm": 3.50}'
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
_See code: [src/commands/sandbox/emit.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/sandbox/emit.ts)_
|
|
1119
|
+
|
|
1120
|
+
## `trillboards sandbox reset`
|
|
1121
|
+
|
|
1122
|
+
Reset the sandbox — delete all test screens and events
|
|
1123
|
+
|
|
1124
|
+
```
|
|
1125
|
+
USAGE
|
|
1126
|
+
$ trillboards sandbox reset [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
1127
|
+
|
|
1128
|
+
FLAGS
|
|
1129
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1130
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1131
|
+
--format=<option> Output format
|
|
1132
|
+
<options: json|table|yaml>
|
|
1133
|
+
|
|
1134
|
+
DESCRIPTION
|
|
1135
|
+
Reset the sandbox — delete all test screens and events
|
|
1136
|
+
|
|
1137
|
+
EXAMPLES
|
|
1138
|
+
$ trillboards sandbox reset
|
|
1139
|
+
|
|
1140
|
+
$ trillboards sandbox reset --format json
|
|
1141
|
+
```
|
|
1142
|
+
|
|
1143
|
+
_See code: [src/commands/sandbox/reset.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/sandbox/reset.ts)_
|
|
1144
|
+
|
|
1145
|
+
## `trillboards sandbox status`
|
|
1146
|
+
|
|
1147
|
+
Show sandbox status — screens and recent events
|
|
1148
|
+
|
|
1149
|
+
```
|
|
1150
|
+
USAGE
|
|
1151
|
+
$ trillboards sandbox status [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
1152
|
+
|
|
1153
|
+
FLAGS
|
|
1154
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1155
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1156
|
+
--format=<option> Output format
|
|
1157
|
+
<options: json|table|yaml>
|
|
1158
|
+
|
|
1159
|
+
DESCRIPTION
|
|
1160
|
+
Show sandbox status — screens and recent events
|
|
1161
|
+
|
|
1162
|
+
EXAMPLES
|
|
1163
|
+
$ trillboards sandbox status
|
|
1164
|
+
|
|
1165
|
+
$ trillboards sandbox status --format json
|
|
1166
|
+
```
|
|
1167
|
+
|
|
1168
|
+
_See code: [src/commands/sandbox/status.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/sandbox/status.ts)_
|
|
1169
|
+
|
|
1170
|
+
## `trillboards screens watch`
|
|
1171
|
+
|
|
1172
|
+
Live fleet dashboard — watch all screens in real-time
|
|
1173
|
+
|
|
1174
|
+
```
|
|
1175
|
+
USAGE
|
|
1176
|
+
$ trillboards screens watch [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--filter
|
|
1177
|
+
online|offline] [--interval <value>] [--sort name|earnings|fill-rate]
|
|
1178
|
+
|
|
1179
|
+
FLAGS
|
|
1180
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1181
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1182
|
+
--filter=<option> Filter screens by status
|
|
1183
|
+
<options: online|offline>
|
|
1184
|
+
--format=<option> Output format
|
|
1185
|
+
<options: json|table|yaml>
|
|
1186
|
+
--interval=<value> [default: 10] Refresh interval in seconds
|
|
1187
|
+
--sort=<option> [default: name] Sort column
|
|
1188
|
+
<options: name|earnings|fill-rate>
|
|
1189
|
+
|
|
1190
|
+
DESCRIPTION
|
|
1191
|
+
Live fleet dashboard — watch all screens in real-time
|
|
1192
|
+
|
|
1193
|
+
EXAMPLES
|
|
1194
|
+
$ trillboards screens watch
|
|
1195
|
+
|
|
1196
|
+
$ trillboards screens watch --filter online
|
|
1197
|
+
|
|
1198
|
+
$ trillboards screens watch --sort earnings
|
|
1199
|
+
|
|
1200
|
+
$ trillboards screens watch --format json
|
|
1201
|
+
```
|
|
1202
|
+
|
|
1203
|
+
_See code: [src/commands/screens/watch.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/screens/watch.ts)_
|
|
1204
|
+
|
|
1205
|
+
## `trillboards trigger [EVENT_TYPE]`
|
|
1206
|
+
|
|
1207
|
+
Fire test events in the sandbox
|
|
1208
|
+
|
|
1209
|
+
```
|
|
1210
|
+
USAGE
|
|
1211
|
+
$ trillboards trigger [EVENT_TYPE] [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
1212
|
+
|
|
1213
|
+
ARGUMENTS
|
|
1214
|
+
[EVENT_TYPE] Event type to fire (e.g. impression_start)
|
|
1215
|
+
|
|
1216
|
+
FLAGS
|
|
1217
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1218
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1219
|
+
--format=<option> Output format
|
|
1220
|
+
<options: json|table|yaml>
|
|
1221
|
+
|
|
1222
|
+
DESCRIPTION
|
|
1223
|
+
Fire test events in the sandbox
|
|
1224
|
+
|
|
1225
|
+
EXAMPLES
|
|
1226
|
+
$ trillboards trigger
|
|
1227
|
+
|
|
1228
|
+
$ trillboards trigger impression_start
|
|
1229
|
+
|
|
1230
|
+
$ trillboards trigger impression_complete --format json
|
|
1231
|
+
```
|
|
1232
|
+
|
|
1233
|
+
_See code: [src/commands/trigger.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/trigger.ts)_
|
|
1234
|
+
|
|
1235
|
+
## `trillboards validate FILE`
|
|
1236
|
+
|
|
1237
|
+
Validate a JSON payload against the API (dry-run)
|
|
1238
|
+
|
|
1239
|
+
```
|
|
1240
|
+
USAGE
|
|
1241
|
+
$ trillboards validate FILE [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-o <value>]
|
|
1242
|
+
|
|
1243
|
+
ARGUMENTS
|
|
1244
|
+
FILE Path to JSON file to validate
|
|
1245
|
+
|
|
1246
|
+
FLAGS
|
|
1247
|
+
-o, --operation=<value> Operation ID for the playground endpoint (e.g. create_screen)
|
|
1248
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1249
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1250
|
+
--format=<option> Output format
|
|
1251
|
+
<options: json|table|yaml>
|
|
1252
|
+
|
|
1253
|
+
DESCRIPTION
|
|
1254
|
+
Validate a JSON payload against the API (dry-run)
|
|
1255
|
+
|
|
1256
|
+
EXAMPLES
|
|
1257
|
+
$ trillboards validate payload.json
|
|
1258
|
+
|
|
1259
|
+
$ trillboards validate payload.json --operation create_screen
|
|
1260
|
+
```
|
|
1261
|
+
|
|
1262
|
+
_See code: [src/commands/validate.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/validate.ts)_
|
|
1263
|
+
|
|
1264
|
+
## `trillboards whoami`
|
|
1265
|
+
|
|
1266
|
+
Show current partner info and API key status
|
|
1267
|
+
|
|
1268
|
+
```
|
|
1269
|
+
USAGE
|
|
1270
|
+
$ trillboards whoami [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
|
|
1271
|
+
|
|
1272
|
+
FLAGS
|
|
1273
|
+
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
|
|
1274
|
+
--base-url=<value> [default: https://api.trillboards.com] API base URL
|
|
1275
|
+
--format=<option> Output format
|
|
1276
|
+
<options: json|table|yaml>
|
|
1277
|
+
|
|
1278
|
+
DESCRIPTION
|
|
1279
|
+
Show current partner info and API key status
|
|
1280
|
+
|
|
1281
|
+
EXAMPLES
|
|
1282
|
+
$ trillboards whoami
|
|
1283
|
+
|
|
1284
|
+
$ trillboards whoami --format json
|
|
1285
|
+
```
|
|
1286
|
+
|
|
1287
|
+
_See code: [src/commands/whoami.ts](https://github.com/trillboards/packages/blob/v0.1.0/src/commands/whoami.ts)_
|
|
1288
|
+
<!-- commandsstop -->
|