@meshery/schemas 1.3.74 → 1.3.75

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.
@@ -0,0 +1,914 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export type paths = Record<string, never>;
7
+ export type webhooks = Record<string, never>;
8
+ export interface components {
9
+ schemas: {
10
+ /**
11
+ * Activity Result Schema
12
+ * @description The result of one activity: whether it went out on each platform and for
13
+ * each profile it was addressed to, how it was received where reception is
14
+ * collected, and the follower change around it. One entry per profile and
15
+ * platform. Every figure says whether it was measured or derived, and
16
+ * anything not collected says so with a reason instead of a zero.
17
+ */
18
+ ActivityResult: {
19
+ /** @description Identifier of the activity the result describes (for a content piece, its row number as a string). */
20
+ activityId: string;
21
+ /** @description What the activity does, such as post, repost, comment, like, connect or invite. */
22
+ kind: string;
23
+ /** @description Platform the activity targets (for example linkedin, x, bluesky). */
24
+ platform: string;
25
+ /** @description Short human-readable preview of the activity. */
26
+ title?: string;
27
+ /** @description The activity's queue state when the result was read (for example done, partial, pending, scheduled, draft). */
28
+ state?: string;
29
+ /**
30
+ * Format: date-time
31
+ * @description When this result was assembled.
32
+ */
33
+ generatedAt: string;
34
+ /** @description One entry per profile and platform the activity is addressed to. */
35
+ entries: {
36
+ /** @description Profile the entry is for. */
37
+ profile: string;
38
+ /** @description Platform the entry is for. */
39
+ platform: string;
40
+ /**
41
+ * @description Whether the activity went out for this profile and platform, from the
42
+ * recorded outcome and the run log. Measured, never derived.
43
+ */
44
+ delivery: {
45
+ /**
46
+ * @description delivered (it went out), unconfirmed (the action was taken but its
47
+ * outcome could not be read), failed (the last attempt failed and it
48
+ * has not gone out), scheduled (due later), pending (due and not yet
49
+ * run), draft (not approved, so it will not run).
50
+ * @enum {string}
51
+ */
52
+ status: "delivered" | "unconfirmed" | "failed" | "scheduled" | "pending" | "draft";
53
+ /**
54
+ * @description What the status rests on: recorded (the outcome stored on the
55
+ * activity), run (a run log entry), or none (nothing has happened yet).
56
+ * @enum {string}
57
+ */
58
+ evidence: "recorded" | "run" | "none";
59
+ /**
60
+ * Format: date-time
61
+ * @description When it went out, as recorded.
62
+ */
63
+ deliveredAt?: string | null;
64
+ /**
65
+ * Format: date-time
66
+ * @description When it is due, for a scheduled or pending activity.
67
+ */
68
+ scheduledFor?: string | null;
69
+ /** @description Link to the live item on the platform. */
70
+ link?: string | null;
71
+ /** @description Host name of the computer whose run delivered or attempted it. */
72
+ computer?: string | null;
73
+ /** @description The browser profile a run used on its computer, when one was mapped. Null when unknown. */
74
+ browserProfile?: {
75
+ /** @description Browser profile directory name. */
76
+ directory: string;
77
+ /** @description Name the browser showed for the profile. */
78
+ displayName?: string;
79
+ } | null;
80
+ /** @description Run log identifier of the run that delivered or attempted it. */
81
+ runId?: string | null;
82
+ /**
83
+ * Format: date-time
84
+ * @description When the matched run ended.
85
+ */
86
+ attemptedAt?: string | null;
87
+ /** @description How long the matched run took. */
88
+ durationSeconds?: number | null;
89
+ /** @description The error the last failed attempt reported. */
90
+ error?: string | null;
91
+ /** @description What to do about a failed delivery. Null when nothing failed. */
92
+ fix?: {
93
+ /** @description One plain sentence saying what to do next. */
94
+ summary: string;
95
+ /** @description A command line that performs the fix, when there is one. */
96
+ command?: string | null;
97
+ } | null;
98
+ /** @description Log file of the matched run, on the computer that ran it. */
99
+ logPath?: string | null;
100
+ };
101
+ /**
102
+ * @description How the activity was received. Measured figures with the date they were
103
+ * read, or collected false with a reason. Never zeros for missing data.
104
+ */
105
+ reception: {
106
+ /** @description Whether any reception figures exist for this entry. */
107
+ collected: boolean;
108
+ /** @description Always true; reception figures are read from the platform, not computed. */
109
+ measured: boolean;
110
+ /**
111
+ * @description Why reception is not collected: platform (nothing collects reception
112
+ * for this platform yet), notdelivered (it has not gone out),
113
+ * nolink (no live link to match on), notmatched (no collected figures
114
+ * match its link yet), unavailable (the store does not hold reception
115
+ * figures).
116
+ * @enum {string}
117
+ */
118
+ reason?: "platform" | "notdelivered" | "nolink" | "notmatched" | "unavailable";
119
+ /** @description One plain sentence for a person explaining the reason. */
120
+ message?: string;
121
+ /** @description Account or page the figures belong to. */
122
+ subject?: string;
123
+ /** @description Where the figures came from, for example a platform analytics export. */
124
+ source?: string;
125
+ /**
126
+ * Format: date
127
+ * @description Date the figures were read; they do not change after it.
128
+ */
129
+ asOf?: string | null;
130
+ /**
131
+ * @description Per-activity engagement figures. The known keys are declared and are
132
+ * null when the source did not report them, never zero. A
133
+ * platform-specific figure not listed here is carried under its own key
134
+ * only when it was reported.
135
+ */
136
+ metrics?: {
137
+ /** @description Times the activity was shown. */
138
+ impressions?: number | null;
139
+ /** @description Views, for media activities. */
140
+ views?: number | null;
141
+ /** @description Views outside the platform. */
142
+ offsiteViews?: number | null;
143
+ /** @description Clicks on the activity. */
144
+ clicks?: number | null;
145
+ /** @description Clicks divided by impressions, as a fraction. */
146
+ clickThroughRate?: number | null;
147
+ /** @description Likes or reactions. */
148
+ likes?: number | null;
149
+ /** @description Comments. */
150
+ comments?: number | null;
151
+ /** @description Reposts or shares. */
152
+ reposts?: number | null;
153
+ /** @description Follows attributed to the activity. */
154
+ follows?: number | null;
155
+ /** @description Engagements divided by impressions, as a fraction. */
156
+ engagementRate?: number | null;
157
+ } & {
158
+ [key: string]: number;
159
+ };
160
+ /**
161
+ * @description Derived. How this activity's figures compare with the same subject's
162
+ * other activities: the median of each figure and this activity's ratio
163
+ * to it. Null when there are too few other activities to compare with.
164
+ */
165
+ comparison?: {
166
+ /**
167
+ * @description How the typical activity is computed.
168
+ * @enum {string}
169
+ */
170
+ basis: "median";
171
+ /** @description How many other activities the median is taken over. */
172
+ sampleSize: number;
173
+ /**
174
+ * @description Per-activity engagement figures. The known keys are declared and are
175
+ * null when the source did not report them, never zero. A
176
+ * platform-specific figure not listed here is carried under its own key
177
+ * only when it was reported.
178
+ */
179
+ median: {
180
+ /** @description Times the activity was shown. */
181
+ impressions?: number | null;
182
+ /** @description Views, for media activities. */
183
+ views?: number | null;
184
+ /** @description Views outside the platform. */
185
+ offsiteViews?: number | null;
186
+ /** @description Clicks on the activity. */
187
+ clicks?: number | null;
188
+ /** @description Clicks divided by impressions, as a fraction. */
189
+ clickThroughRate?: number | null;
190
+ /** @description Likes or reactions. */
191
+ likes?: number | null;
192
+ /** @description Comments. */
193
+ comments?: number | null;
194
+ /** @description Reposts or shares. */
195
+ reposts?: number | null;
196
+ /** @description Follows attributed to the activity. */
197
+ follows?: number | null;
198
+ /** @description Engagements divided by impressions, as a fraction. */
199
+ engagementRate?: number | null;
200
+ } & {
201
+ [key: string]: number;
202
+ };
203
+ /**
204
+ * @description Per-activity engagement figures. The known keys are declared and are
205
+ * null when the source did not report them, never zero. A
206
+ * platform-specific figure not listed here is carried under its own key
207
+ * only when it was reported.
208
+ */
209
+ ratio: {
210
+ /** @description Times the activity was shown. */
211
+ impressions?: number | null;
212
+ /** @description Views, for media activities. */
213
+ views?: number | null;
214
+ /** @description Views outside the platform. */
215
+ offsiteViews?: number | null;
216
+ /** @description Clicks on the activity. */
217
+ clicks?: number | null;
218
+ /** @description Clicks divided by impressions, as a fraction. */
219
+ clickThroughRate?: number | null;
220
+ /** @description Likes or reactions. */
221
+ likes?: number | null;
222
+ /** @description Comments. */
223
+ comments?: number | null;
224
+ /** @description Reposts or shares. */
225
+ reposts?: number | null;
226
+ /** @description Follows attributed to the activity. */
227
+ follows?: number | null;
228
+ /** @description Engagements divided by impressions, as a fraction. */
229
+ engagementRate?: number | null;
230
+ } & {
231
+ [key: string]: number;
232
+ };
233
+ } | null;
234
+ };
235
+ /**
236
+ * @description Derived. The subject's follower count at the reading before the activity
237
+ * and the first reading at least the stated number of days after it.
238
+ * Correlation only; it does not claim the activity caused the change.
239
+ */
240
+ followerChange: {
241
+ /** @description Whether follower readings exist on both sides of the activity. */
242
+ collected: boolean;
243
+ /** @description Always true; the change is computed from two measured readings. */
244
+ derived: boolean;
245
+ /**
246
+ * @description Why there is no change: platform (followers are not collected for
247
+ * this subject's platform), notdelivered, noreadings (no reading on
248
+ * one side of the activity yet).
249
+ * @enum {string}
250
+ */
251
+ reason?: "platform" | "notdelivered" | "noreadings";
252
+ /** @description One plain sentence for a person explaining the reason. */
253
+ message?: string;
254
+ /** @description Account or page whose followers were read. */
255
+ subject?: string;
256
+ /** @description How the change is computed. */
257
+ formula?: string;
258
+ /** @description Days after the activity the later reading is taken from, at least. */
259
+ windowDays?: number;
260
+ /** @description One measured follower reading. Null when there is none. */
261
+ before?: {
262
+ /**
263
+ * Format: date
264
+ * @description Date of the reading.
265
+ */
266
+ date: string;
267
+ /** @description Followers at that reading. */
268
+ followers: number;
269
+ } | null;
270
+ /** @description One measured follower reading. Null when there is none. */
271
+ after?: {
272
+ /**
273
+ * Format: date
274
+ * @description Date of the reading.
275
+ */
276
+ date: string;
277
+ /** @description Followers at that reading. */
278
+ followers: number;
279
+ } | null;
280
+ /** @description after.followers minus before.followers. */
281
+ change?: number | null;
282
+ };
283
+ }[];
284
+ };
285
+ /** @description The result of an activity for one profile on one platform. */
286
+ ActivityResultEntry: {
287
+ /** @description Profile the entry is for. */
288
+ profile: string;
289
+ /** @description Platform the entry is for. */
290
+ platform: string;
291
+ /**
292
+ * @description Whether the activity went out for this profile and platform, from the
293
+ * recorded outcome and the run log. Measured, never derived.
294
+ */
295
+ delivery: {
296
+ /**
297
+ * @description delivered (it went out), unconfirmed (the action was taken but its
298
+ * outcome could not be read), failed (the last attempt failed and it
299
+ * has not gone out), scheduled (due later), pending (due and not yet
300
+ * run), draft (not approved, so it will not run).
301
+ * @enum {string}
302
+ */
303
+ status: "delivered" | "unconfirmed" | "failed" | "scheduled" | "pending" | "draft";
304
+ /**
305
+ * @description What the status rests on: recorded (the outcome stored on the
306
+ * activity), run (a run log entry), or none (nothing has happened yet).
307
+ * @enum {string}
308
+ */
309
+ evidence: "recorded" | "run" | "none";
310
+ /**
311
+ * Format: date-time
312
+ * @description When it went out, as recorded.
313
+ */
314
+ deliveredAt?: string | null;
315
+ /**
316
+ * Format: date-time
317
+ * @description When it is due, for a scheduled or pending activity.
318
+ */
319
+ scheduledFor?: string | null;
320
+ /** @description Link to the live item on the platform. */
321
+ link?: string | null;
322
+ /** @description Host name of the computer whose run delivered or attempted it. */
323
+ computer?: string | null;
324
+ /** @description The browser profile a run used on its computer, when one was mapped. Null when unknown. */
325
+ browserProfile?: {
326
+ /** @description Browser profile directory name. */
327
+ directory: string;
328
+ /** @description Name the browser showed for the profile. */
329
+ displayName?: string;
330
+ } | null;
331
+ /** @description Run log identifier of the run that delivered or attempted it. */
332
+ runId?: string | null;
333
+ /**
334
+ * Format: date-time
335
+ * @description When the matched run ended.
336
+ */
337
+ attemptedAt?: string | null;
338
+ /** @description How long the matched run took. */
339
+ durationSeconds?: number | null;
340
+ /** @description The error the last failed attempt reported. */
341
+ error?: string | null;
342
+ /** @description What to do about a failed delivery. Null when nothing failed. */
343
+ fix?: {
344
+ /** @description One plain sentence saying what to do next. */
345
+ summary: string;
346
+ /** @description A command line that performs the fix, when there is one. */
347
+ command?: string | null;
348
+ } | null;
349
+ /** @description Log file of the matched run, on the computer that ran it. */
350
+ logPath?: string | null;
351
+ };
352
+ /**
353
+ * @description How the activity was received. Measured figures with the date they were
354
+ * read, or collected false with a reason. Never zeros for missing data.
355
+ */
356
+ reception: {
357
+ /** @description Whether any reception figures exist for this entry. */
358
+ collected: boolean;
359
+ /** @description Always true; reception figures are read from the platform, not computed. */
360
+ measured: boolean;
361
+ /**
362
+ * @description Why reception is not collected: platform (nothing collects reception
363
+ * for this platform yet), notdelivered (it has not gone out),
364
+ * nolink (no live link to match on), notmatched (no collected figures
365
+ * match its link yet), unavailable (the store does not hold reception
366
+ * figures).
367
+ * @enum {string}
368
+ */
369
+ reason?: "platform" | "notdelivered" | "nolink" | "notmatched" | "unavailable";
370
+ /** @description One plain sentence for a person explaining the reason. */
371
+ message?: string;
372
+ /** @description Account or page the figures belong to. */
373
+ subject?: string;
374
+ /** @description Where the figures came from, for example a platform analytics export. */
375
+ source?: string;
376
+ /**
377
+ * Format: date
378
+ * @description Date the figures were read; they do not change after it.
379
+ */
380
+ asOf?: string | null;
381
+ /**
382
+ * @description Per-activity engagement figures. The known keys are declared and are
383
+ * null when the source did not report them, never zero. A
384
+ * platform-specific figure not listed here is carried under its own key
385
+ * only when it was reported.
386
+ */
387
+ metrics?: {
388
+ /** @description Times the activity was shown. */
389
+ impressions?: number | null;
390
+ /** @description Views, for media activities. */
391
+ views?: number | null;
392
+ /** @description Views outside the platform. */
393
+ offsiteViews?: number | null;
394
+ /** @description Clicks on the activity. */
395
+ clicks?: number | null;
396
+ /** @description Clicks divided by impressions, as a fraction. */
397
+ clickThroughRate?: number | null;
398
+ /** @description Likes or reactions. */
399
+ likes?: number | null;
400
+ /** @description Comments. */
401
+ comments?: number | null;
402
+ /** @description Reposts or shares. */
403
+ reposts?: number | null;
404
+ /** @description Follows attributed to the activity. */
405
+ follows?: number | null;
406
+ /** @description Engagements divided by impressions, as a fraction. */
407
+ engagementRate?: number | null;
408
+ } & {
409
+ [key: string]: number;
410
+ };
411
+ /**
412
+ * @description Derived. How this activity's figures compare with the same subject's
413
+ * other activities: the median of each figure and this activity's ratio
414
+ * to it. Null when there are too few other activities to compare with.
415
+ */
416
+ comparison?: {
417
+ /**
418
+ * @description How the typical activity is computed.
419
+ * @enum {string}
420
+ */
421
+ basis: "median";
422
+ /** @description How many other activities the median is taken over. */
423
+ sampleSize: number;
424
+ /**
425
+ * @description Per-activity engagement figures. The known keys are declared and are
426
+ * null when the source did not report them, never zero. A
427
+ * platform-specific figure not listed here is carried under its own key
428
+ * only when it was reported.
429
+ */
430
+ median: {
431
+ /** @description Times the activity was shown. */
432
+ impressions?: number | null;
433
+ /** @description Views, for media activities. */
434
+ views?: number | null;
435
+ /** @description Views outside the platform. */
436
+ offsiteViews?: number | null;
437
+ /** @description Clicks on the activity. */
438
+ clicks?: number | null;
439
+ /** @description Clicks divided by impressions, as a fraction. */
440
+ clickThroughRate?: number | null;
441
+ /** @description Likes or reactions. */
442
+ likes?: number | null;
443
+ /** @description Comments. */
444
+ comments?: number | null;
445
+ /** @description Reposts or shares. */
446
+ reposts?: number | null;
447
+ /** @description Follows attributed to the activity. */
448
+ follows?: number | null;
449
+ /** @description Engagements divided by impressions, as a fraction. */
450
+ engagementRate?: number | null;
451
+ } & {
452
+ [key: string]: number;
453
+ };
454
+ /**
455
+ * @description Per-activity engagement figures. The known keys are declared and are
456
+ * null when the source did not report them, never zero. A
457
+ * platform-specific figure not listed here is carried under its own key
458
+ * only when it was reported.
459
+ */
460
+ ratio: {
461
+ /** @description Times the activity was shown. */
462
+ impressions?: number | null;
463
+ /** @description Views, for media activities. */
464
+ views?: number | null;
465
+ /** @description Views outside the platform. */
466
+ offsiteViews?: number | null;
467
+ /** @description Clicks on the activity. */
468
+ clicks?: number | null;
469
+ /** @description Clicks divided by impressions, as a fraction. */
470
+ clickThroughRate?: number | null;
471
+ /** @description Likes or reactions. */
472
+ likes?: number | null;
473
+ /** @description Comments. */
474
+ comments?: number | null;
475
+ /** @description Reposts or shares. */
476
+ reposts?: number | null;
477
+ /** @description Follows attributed to the activity. */
478
+ follows?: number | null;
479
+ /** @description Engagements divided by impressions, as a fraction. */
480
+ engagementRate?: number | null;
481
+ } & {
482
+ [key: string]: number;
483
+ };
484
+ } | null;
485
+ };
486
+ /**
487
+ * @description Derived. The subject's follower count at the reading before the activity
488
+ * and the first reading at least the stated number of days after it.
489
+ * Correlation only; it does not claim the activity caused the change.
490
+ */
491
+ followerChange: {
492
+ /** @description Whether follower readings exist on both sides of the activity. */
493
+ collected: boolean;
494
+ /** @description Always true; the change is computed from two measured readings. */
495
+ derived: boolean;
496
+ /**
497
+ * @description Why there is no change: platform (followers are not collected for
498
+ * this subject's platform), notdelivered, noreadings (no reading on
499
+ * one side of the activity yet).
500
+ * @enum {string}
501
+ */
502
+ reason?: "platform" | "notdelivered" | "noreadings";
503
+ /** @description One plain sentence for a person explaining the reason. */
504
+ message?: string;
505
+ /** @description Account or page whose followers were read. */
506
+ subject?: string;
507
+ /** @description How the change is computed. */
508
+ formula?: string;
509
+ /** @description Days after the activity the later reading is taken from, at least. */
510
+ windowDays?: number;
511
+ /** @description One measured follower reading. Null when there is none. */
512
+ before?: {
513
+ /**
514
+ * Format: date
515
+ * @description Date of the reading.
516
+ */
517
+ date: string;
518
+ /** @description Followers at that reading. */
519
+ followers: number;
520
+ } | null;
521
+ /** @description One measured follower reading. Null when there is none. */
522
+ after?: {
523
+ /**
524
+ * Format: date
525
+ * @description Date of the reading.
526
+ */
527
+ date: string;
528
+ /** @description Followers at that reading. */
529
+ followers: number;
530
+ } | null;
531
+ /** @description after.followers minus before.followers. */
532
+ change?: number | null;
533
+ };
534
+ };
535
+ /**
536
+ * @description Whether the activity went out for this profile and platform, from the
537
+ * recorded outcome and the run log. Measured, never derived.
538
+ */
539
+ ActivityDelivery: {
540
+ /**
541
+ * @description delivered (it went out), unconfirmed (the action was taken but its
542
+ * outcome could not be read), failed (the last attempt failed and it
543
+ * has not gone out), scheduled (due later), pending (due and not yet
544
+ * run), draft (not approved, so it will not run).
545
+ * @enum {string}
546
+ */
547
+ status: "delivered" | "unconfirmed" | "failed" | "scheduled" | "pending" | "draft";
548
+ /**
549
+ * @description What the status rests on: recorded (the outcome stored on the
550
+ * activity), run (a run log entry), or none (nothing has happened yet).
551
+ * @enum {string}
552
+ */
553
+ evidence: "recorded" | "run" | "none";
554
+ /**
555
+ * Format: date-time
556
+ * @description When it went out, as recorded.
557
+ */
558
+ deliveredAt?: string | null;
559
+ /**
560
+ * Format: date-time
561
+ * @description When it is due, for a scheduled or pending activity.
562
+ */
563
+ scheduledFor?: string | null;
564
+ /** @description Link to the live item on the platform. */
565
+ link?: string | null;
566
+ /** @description Host name of the computer whose run delivered or attempted it. */
567
+ computer?: string | null;
568
+ /** @description The browser profile a run used on its computer, when one was mapped. Null when unknown. */
569
+ browserProfile?: {
570
+ /** @description Browser profile directory name. */
571
+ directory: string;
572
+ /** @description Name the browser showed for the profile. */
573
+ displayName?: string;
574
+ } | null;
575
+ /** @description Run log identifier of the run that delivered or attempted it. */
576
+ runId?: string | null;
577
+ /**
578
+ * Format: date-time
579
+ * @description When the matched run ended.
580
+ */
581
+ attemptedAt?: string | null;
582
+ /** @description How long the matched run took. */
583
+ durationSeconds?: number | null;
584
+ /** @description The error the last failed attempt reported. */
585
+ error?: string | null;
586
+ /** @description What to do about a failed delivery. Null when nothing failed. */
587
+ fix?: {
588
+ /** @description One plain sentence saying what to do next. */
589
+ summary: string;
590
+ /** @description A command line that performs the fix, when there is one. */
591
+ command?: string | null;
592
+ } | null;
593
+ /** @description Log file of the matched run, on the computer that ran it. */
594
+ logPath?: string | null;
595
+ };
596
+ /** @description The browser profile a run used on its computer, when one was mapped. Null when unknown. */
597
+ ActivityBrowserProfile: {
598
+ /** @description Browser profile directory name. */
599
+ directory: string;
600
+ /** @description Name the browser showed for the profile. */
601
+ displayName?: string;
602
+ } | null;
603
+ /** @description What to do about a failed delivery. Null when nothing failed. */
604
+ ActivityFix: {
605
+ /** @description One plain sentence saying what to do next. */
606
+ summary: string;
607
+ /** @description A command line that performs the fix, when there is one. */
608
+ command?: string | null;
609
+ } | null;
610
+ /**
611
+ * @description Per-activity engagement figures. The known keys are declared and are
612
+ * null when the source did not report them, never zero. A
613
+ * platform-specific figure not listed here is carried under its own key
614
+ * only when it was reported.
615
+ */
616
+ ActivityMetrics: {
617
+ /** @description Times the activity was shown. */
618
+ impressions?: number | null;
619
+ /** @description Views, for media activities. */
620
+ views?: number | null;
621
+ /** @description Views outside the platform. */
622
+ offsiteViews?: number | null;
623
+ /** @description Clicks on the activity. */
624
+ clicks?: number | null;
625
+ /** @description Clicks divided by impressions, as a fraction. */
626
+ clickThroughRate?: number | null;
627
+ /** @description Likes or reactions. */
628
+ likes?: number | null;
629
+ /** @description Comments. */
630
+ comments?: number | null;
631
+ /** @description Reposts or shares. */
632
+ reposts?: number | null;
633
+ /** @description Follows attributed to the activity. */
634
+ follows?: number | null;
635
+ /** @description Engagements divided by impressions, as a fraction. */
636
+ engagementRate?: number | null;
637
+ } & {
638
+ [key: string]: number;
639
+ };
640
+ /**
641
+ * @description Derived. How this activity's figures compare with the same subject's
642
+ * other activities: the median of each figure and this activity's ratio
643
+ * to it. Null when there are too few other activities to compare with.
644
+ */
645
+ ActivityComparison: {
646
+ /**
647
+ * @description How the typical activity is computed.
648
+ * @enum {string}
649
+ */
650
+ basis: "median";
651
+ /** @description How many other activities the median is taken over. */
652
+ sampleSize: number;
653
+ /**
654
+ * @description Per-activity engagement figures. The known keys are declared and are
655
+ * null when the source did not report them, never zero. A
656
+ * platform-specific figure not listed here is carried under its own key
657
+ * only when it was reported.
658
+ */
659
+ median: {
660
+ /** @description Times the activity was shown. */
661
+ impressions?: number | null;
662
+ /** @description Views, for media activities. */
663
+ views?: number | null;
664
+ /** @description Views outside the platform. */
665
+ offsiteViews?: number | null;
666
+ /** @description Clicks on the activity. */
667
+ clicks?: number | null;
668
+ /** @description Clicks divided by impressions, as a fraction. */
669
+ clickThroughRate?: number | null;
670
+ /** @description Likes or reactions. */
671
+ likes?: number | null;
672
+ /** @description Comments. */
673
+ comments?: number | null;
674
+ /** @description Reposts or shares. */
675
+ reposts?: number | null;
676
+ /** @description Follows attributed to the activity. */
677
+ follows?: number | null;
678
+ /** @description Engagements divided by impressions, as a fraction. */
679
+ engagementRate?: number | null;
680
+ } & {
681
+ [key: string]: number;
682
+ };
683
+ /**
684
+ * @description Per-activity engagement figures. The known keys are declared and are
685
+ * null when the source did not report them, never zero. A
686
+ * platform-specific figure not listed here is carried under its own key
687
+ * only when it was reported.
688
+ */
689
+ ratio: {
690
+ /** @description Times the activity was shown. */
691
+ impressions?: number | null;
692
+ /** @description Views, for media activities. */
693
+ views?: number | null;
694
+ /** @description Views outside the platform. */
695
+ offsiteViews?: number | null;
696
+ /** @description Clicks on the activity. */
697
+ clicks?: number | null;
698
+ /** @description Clicks divided by impressions, as a fraction. */
699
+ clickThroughRate?: number | null;
700
+ /** @description Likes or reactions. */
701
+ likes?: number | null;
702
+ /** @description Comments. */
703
+ comments?: number | null;
704
+ /** @description Reposts or shares. */
705
+ reposts?: number | null;
706
+ /** @description Follows attributed to the activity. */
707
+ follows?: number | null;
708
+ /** @description Engagements divided by impressions, as a fraction. */
709
+ engagementRate?: number | null;
710
+ } & {
711
+ [key: string]: number;
712
+ };
713
+ } | null;
714
+ /**
715
+ * @description How the activity was received. Measured figures with the date they were
716
+ * read, or collected false with a reason. Never zeros for missing data.
717
+ */
718
+ ActivityReception: {
719
+ /** @description Whether any reception figures exist for this entry. */
720
+ collected: boolean;
721
+ /** @description Always true; reception figures are read from the platform, not computed. */
722
+ measured: boolean;
723
+ /**
724
+ * @description Why reception is not collected: platform (nothing collects reception
725
+ * for this platform yet), notdelivered (it has not gone out),
726
+ * nolink (no live link to match on), notmatched (no collected figures
727
+ * match its link yet), unavailable (the store does not hold reception
728
+ * figures).
729
+ * @enum {string}
730
+ */
731
+ reason?: "platform" | "notdelivered" | "nolink" | "notmatched" | "unavailable";
732
+ /** @description One plain sentence for a person explaining the reason. */
733
+ message?: string;
734
+ /** @description Account or page the figures belong to. */
735
+ subject?: string;
736
+ /** @description Where the figures came from, for example a platform analytics export. */
737
+ source?: string;
738
+ /**
739
+ * Format: date
740
+ * @description Date the figures were read; they do not change after it.
741
+ */
742
+ asOf?: string | null;
743
+ /**
744
+ * @description Per-activity engagement figures. The known keys are declared and are
745
+ * null when the source did not report them, never zero. A
746
+ * platform-specific figure not listed here is carried under its own key
747
+ * only when it was reported.
748
+ */
749
+ metrics?: {
750
+ /** @description Times the activity was shown. */
751
+ impressions?: number | null;
752
+ /** @description Views, for media activities. */
753
+ views?: number | null;
754
+ /** @description Views outside the platform. */
755
+ offsiteViews?: number | null;
756
+ /** @description Clicks on the activity. */
757
+ clicks?: number | null;
758
+ /** @description Clicks divided by impressions, as a fraction. */
759
+ clickThroughRate?: number | null;
760
+ /** @description Likes or reactions. */
761
+ likes?: number | null;
762
+ /** @description Comments. */
763
+ comments?: number | null;
764
+ /** @description Reposts or shares. */
765
+ reposts?: number | null;
766
+ /** @description Follows attributed to the activity. */
767
+ follows?: number | null;
768
+ /** @description Engagements divided by impressions, as a fraction. */
769
+ engagementRate?: number | null;
770
+ } & {
771
+ [key: string]: number;
772
+ };
773
+ /**
774
+ * @description Derived. How this activity's figures compare with the same subject's
775
+ * other activities: the median of each figure and this activity's ratio
776
+ * to it. Null when there are too few other activities to compare with.
777
+ */
778
+ comparison?: {
779
+ /**
780
+ * @description How the typical activity is computed.
781
+ * @enum {string}
782
+ */
783
+ basis: "median";
784
+ /** @description How many other activities the median is taken over. */
785
+ sampleSize: number;
786
+ /**
787
+ * @description Per-activity engagement figures. The known keys are declared and are
788
+ * null when the source did not report them, never zero. A
789
+ * platform-specific figure not listed here is carried under its own key
790
+ * only when it was reported.
791
+ */
792
+ median: {
793
+ /** @description Times the activity was shown. */
794
+ impressions?: number | null;
795
+ /** @description Views, for media activities. */
796
+ views?: number | null;
797
+ /** @description Views outside the platform. */
798
+ offsiteViews?: number | null;
799
+ /** @description Clicks on the activity. */
800
+ clicks?: number | null;
801
+ /** @description Clicks divided by impressions, as a fraction. */
802
+ clickThroughRate?: number | null;
803
+ /** @description Likes or reactions. */
804
+ likes?: number | null;
805
+ /** @description Comments. */
806
+ comments?: number | null;
807
+ /** @description Reposts or shares. */
808
+ reposts?: number | null;
809
+ /** @description Follows attributed to the activity. */
810
+ follows?: number | null;
811
+ /** @description Engagements divided by impressions, as a fraction. */
812
+ engagementRate?: number | null;
813
+ } & {
814
+ [key: string]: number;
815
+ };
816
+ /**
817
+ * @description Per-activity engagement figures. The known keys are declared and are
818
+ * null when the source did not report them, never zero. A
819
+ * platform-specific figure not listed here is carried under its own key
820
+ * only when it was reported.
821
+ */
822
+ ratio: {
823
+ /** @description Times the activity was shown. */
824
+ impressions?: number | null;
825
+ /** @description Views, for media activities. */
826
+ views?: number | null;
827
+ /** @description Views outside the platform. */
828
+ offsiteViews?: number | null;
829
+ /** @description Clicks on the activity. */
830
+ clicks?: number | null;
831
+ /** @description Clicks divided by impressions, as a fraction. */
832
+ clickThroughRate?: number | null;
833
+ /** @description Likes or reactions. */
834
+ likes?: number | null;
835
+ /** @description Comments. */
836
+ comments?: number | null;
837
+ /** @description Reposts or shares. */
838
+ reposts?: number | null;
839
+ /** @description Follows attributed to the activity. */
840
+ follows?: number | null;
841
+ /** @description Engagements divided by impressions, as a fraction. */
842
+ engagementRate?: number | null;
843
+ } & {
844
+ [key: string]: number;
845
+ };
846
+ } | null;
847
+ };
848
+ /**
849
+ * @description Derived. The subject's follower count at the reading before the activity
850
+ * and the first reading at least the stated number of days after it.
851
+ * Correlation only; it does not claim the activity caused the change.
852
+ */
853
+ ActivityFollowerChange: {
854
+ /** @description Whether follower readings exist on both sides of the activity. */
855
+ collected: boolean;
856
+ /** @description Always true; the change is computed from two measured readings. */
857
+ derived: boolean;
858
+ /**
859
+ * @description Why there is no change: platform (followers are not collected for
860
+ * this subject's platform), notdelivered, noreadings (no reading on
861
+ * one side of the activity yet).
862
+ * @enum {string}
863
+ */
864
+ reason?: "platform" | "notdelivered" | "noreadings";
865
+ /** @description One plain sentence for a person explaining the reason. */
866
+ message?: string;
867
+ /** @description Account or page whose followers were read. */
868
+ subject?: string;
869
+ /** @description How the change is computed. */
870
+ formula?: string;
871
+ /** @description Days after the activity the later reading is taken from, at least. */
872
+ windowDays?: number;
873
+ /** @description One measured follower reading. Null when there is none. */
874
+ before?: {
875
+ /**
876
+ * Format: date
877
+ * @description Date of the reading.
878
+ */
879
+ date: string;
880
+ /** @description Followers at that reading. */
881
+ followers: number;
882
+ } | null;
883
+ /** @description One measured follower reading. Null when there is none. */
884
+ after?: {
885
+ /**
886
+ * Format: date
887
+ * @description Date of the reading.
888
+ */
889
+ date: string;
890
+ /** @description Followers at that reading. */
891
+ followers: number;
892
+ } | null;
893
+ /** @description after.followers minus before.followers. */
894
+ change?: number | null;
895
+ };
896
+ /** @description One measured follower reading. Null when there is none. */
897
+ ActivityFollowerReading: {
898
+ /**
899
+ * Format: date
900
+ * @description Date of the reading.
901
+ */
902
+ date: string;
903
+ /** @description Followers at that reading. */
904
+ followers: number;
905
+ } | null;
906
+ };
907
+ responses: never;
908
+ parameters: never;
909
+ requestBodies: never;
910
+ headers: never;
911
+ pathItems: never;
912
+ }
913
+ export type $defs = Record<string, never>;
914
+ export type operations = Record<string, never>;