@mentio-dev/sdk 0.4.2 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +960 -53
- package/dist/index.js +73 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -349,6 +349,35 @@ type Keyword = {
|
|
|
349
349
|
* Platforms this keyword is tracked on; null means every platform.
|
|
350
350
|
*/
|
|
351
351
|
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
352
|
+
/**
|
|
353
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
354
|
+
*/
|
|
355
|
+
context: string | null;
|
|
356
|
+
/**
|
|
357
|
+
* Matching rules applied before a mention is stored; a rejected post is never billed.
|
|
358
|
+
*/
|
|
359
|
+
matching: {
|
|
360
|
+
/**
|
|
361
|
+
* The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
|
|
362
|
+
*/
|
|
363
|
+
requiredTerms: Array<string>;
|
|
364
|
+
/**
|
|
365
|
+
* any: at least one required term must appear. all: every one must.
|
|
366
|
+
*/
|
|
367
|
+
requiredMode: 'any' | 'all';
|
|
368
|
+
/**
|
|
369
|
+
* A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
|
|
370
|
+
*/
|
|
371
|
+
excludedTerms: Array<string>;
|
|
372
|
+
/**
|
|
373
|
+
* Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
|
|
374
|
+
*/
|
|
375
|
+
excludedAuthors: Array<string>;
|
|
376
|
+
/**
|
|
377
|
+
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
378
|
+
*/
|
|
379
|
+
caseSensitive: boolean;
|
|
380
|
+
};
|
|
352
381
|
/**
|
|
353
382
|
* Computed over this workspace's matches.
|
|
354
383
|
*/
|
|
@@ -369,6 +398,19 @@ type Keyword = {
|
|
|
369
398
|
* Newest matched post; null until the first one.
|
|
370
399
|
*/
|
|
371
400
|
lastMentionAt: string | null;
|
|
401
|
+
/**
|
|
402
|
+
* Your verdicts on this keyword's mentions (PATCH /v1/mentions/{id} relevant).
|
|
403
|
+
*/
|
|
404
|
+
feedback: {
|
|
405
|
+
/**
|
|
406
|
+
* Mentions a person marked relevant.
|
|
407
|
+
*/
|
|
408
|
+
relevant: number;
|
|
409
|
+
/**
|
|
410
|
+
* Mentions a person marked not relevant: the noise the classifier let through.
|
|
411
|
+
*/
|
|
412
|
+
notRelevant: number;
|
|
413
|
+
};
|
|
372
414
|
};
|
|
373
415
|
/**
|
|
374
416
|
* Poll health per platform polled on a schedule. Live feeds (Bluesky) have no entry.
|
|
@@ -400,7 +442,7 @@ type ErrorResponse = {
|
|
|
400
442
|
/**
|
|
401
443
|
* Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.
|
|
402
444
|
*/
|
|
403
|
-
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'invalid_member' | 'duplicate_segment' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
445
|
+
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
404
446
|
/**
|
|
405
447
|
* Human-readable detail; may change between releases.
|
|
406
448
|
*/
|
|
@@ -415,6 +457,40 @@ type ErrorResponse = {
|
|
|
415
457
|
retryAfterSeconds?: number;
|
|
416
458
|
};
|
|
417
459
|
};
|
|
460
|
+
/**
|
|
461
|
+
* Workspace-wide matching rules; a rejected post is never billed.
|
|
462
|
+
*/
|
|
463
|
+
type WorkspaceFilters = {
|
|
464
|
+
/**
|
|
465
|
+
* A post containing any of these is dropped, whatever keyword matched it. Same phrase rule as a keyword; a `*` at an end is a wildcard. "hiring, job, careers" is the classic list.
|
|
466
|
+
*/
|
|
467
|
+
excludedTerms: Array<string>;
|
|
468
|
+
/**
|
|
469
|
+
* Posts by these authors are dropped everywhere: your own accounts, employees, known spammers. Profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form.
|
|
470
|
+
*/
|
|
471
|
+
excludedAuthors: Array<string>;
|
|
472
|
+
/**
|
|
473
|
+
* GitHub repositories whose issues, pull requests and comments are dropped, as owner/name or a github.com link (facebook/react, https://github.com/facebook/react).
|
|
474
|
+
*/
|
|
475
|
+
excludedRepos: Array<string>;
|
|
476
|
+
/**
|
|
477
|
+
* Reddit only.
|
|
478
|
+
*/
|
|
479
|
+
subreddits: {
|
|
480
|
+
/**
|
|
481
|
+
* When non-empty, ONLY Reddit posts from these subreddits pass and `excluded` is ignored. r/name or name.
|
|
482
|
+
*/
|
|
483
|
+
only: Array<string>;
|
|
484
|
+
/**
|
|
485
|
+
* Reddit posts from these subreddits are dropped. r/name or name.
|
|
486
|
+
*/
|
|
487
|
+
excluded: Array<string>;
|
|
488
|
+
};
|
|
489
|
+
/**
|
|
490
|
+
* Last edit; null until the first.
|
|
491
|
+
*/
|
|
492
|
+
updatedAt: string | null;
|
|
493
|
+
};
|
|
418
494
|
type Mention = {
|
|
419
495
|
/**
|
|
420
496
|
* Mention id (mm_...): one post matched to one of your keywords. A post matching two keywords has two ids.
|
|
@@ -516,7 +592,7 @@ type Mention = {
|
|
|
516
592
|
tags: Array<string>;
|
|
517
593
|
} | null;
|
|
518
594
|
/**
|
|
519
|
-
* The classifier verdict; null while the post is still queued for classification.
|
|
595
|
+
* The classifier verdict, as corrected by your feedback; null while the post is still queued for classification.
|
|
520
596
|
*/
|
|
521
597
|
classification: {
|
|
522
598
|
/**
|
|
@@ -528,13 +604,25 @@ type Mention = {
|
|
|
528
604
|
*/
|
|
529
605
|
sentiment: 'positive' | 'neutral' | 'negative';
|
|
530
606
|
/**
|
|
531
|
-
*
|
|
607
|
+
* Intent and topic tags: buy_intent, question, complaint, praise, comparison, churn_intent (leaving or replacing the keyword), bug_report, pricing, hiring, event, promotional.
|
|
532
608
|
*/
|
|
533
609
|
intents: Array<string>;
|
|
534
610
|
/**
|
|
535
611
|
* The post reads as machine-made: a bot or app account, a scheduled or templated post, an obvious AI-written summary. A label only: automated mentions stay in the feed, are delivered as usual and are billed like any other match. false while unjudged.
|
|
536
612
|
*/
|
|
537
613
|
automated: boolean;
|
|
614
|
+
/**
|
|
615
|
+
* The language the post is written in, as an ISO 639-1 code (en, es, de); null when unknown or classified before languages were recorded.
|
|
616
|
+
*/
|
|
617
|
+
language: string | null;
|
|
618
|
+
/**
|
|
619
|
+
* How sure the classifier is of its relevance verdict, 0 to 1. null when the verdict came without one: the fallback model judged, or the row was scored before confidence was recorded.
|
|
620
|
+
*/
|
|
621
|
+
confidence: number | null;
|
|
622
|
+
/**
|
|
623
|
+
* The verdict deserves a human look: confidence under 0.4, or the model that wrote the note disagreed with the verdict. A flag for reviewers; it never hides a mention.
|
|
624
|
+
*/
|
|
625
|
+
uncertain: boolean;
|
|
538
626
|
/**
|
|
539
627
|
* One sentence from the classifier explaining the score.
|
|
540
628
|
*/
|
|
@@ -543,6 +631,36 @@ type Mention = {
|
|
|
543
631
|
* true when the model could not score this post; it stays in the feed and is not billed.
|
|
544
632
|
*/
|
|
545
633
|
failed: boolean;
|
|
634
|
+
/**
|
|
635
|
+
* A person's correction of the verdict, or null. A relevance verdict sets `relevance` to 100 or 0 and `relevant` with it; a corrected sentiment replaces `sentiment`. Every list, filter, digest and report reads the corrected values.
|
|
636
|
+
*/
|
|
637
|
+
feedback: {
|
|
638
|
+
/**
|
|
639
|
+
* Your verdict on relevance, or null when you only corrected the sentiment.
|
|
640
|
+
*/
|
|
641
|
+
relevant: boolean | null;
|
|
642
|
+
/**
|
|
643
|
+
* Your corrected sentiment, or null when you only judged relevance.
|
|
644
|
+
*/
|
|
645
|
+
sentiment: 'positive' | 'neutral' | 'negative';
|
|
646
|
+
/**
|
|
647
|
+
* When the last verdict was given.
|
|
648
|
+
*/
|
|
649
|
+
at: string;
|
|
650
|
+
/**
|
|
651
|
+
* The classifier values your feedback replaced.
|
|
652
|
+
*/
|
|
653
|
+
original: {
|
|
654
|
+
/**
|
|
655
|
+
* What the classifier scored before your verdict; null if it had not scored it.
|
|
656
|
+
*/
|
|
657
|
+
relevance: number | null;
|
|
658
|
+
/**
|
|
659
|
+
* The sentiment the classifier gave before your correction.
|
|
660
|
+
*/
|
|
661
|
+
sentiment: 'positive' | 'neutral' | 'negative';
|
|
662
|
+
};
|
|
663
|
+
} | null;
|
|
546
664
|
} | null;
|
|
547
665
|
triage: {
|
|
548
666
|
/**
|
|
@@ -865,11 +983,211 @@ type Company = {
|
|
|
865
983
|
*/
|
|
866
984
|
linkedin: string | null;
|
|
867
985
|
};
|
|
986
|
+
/**
|
|
987
|
+
* The company website, as set up during onboarding.
|
|
988
|
+
*/
|
|
989
|
+
website: string | null;
|
|
990
|
+
/**
|
|
991
|
+
* Competitors by name, so the classifier reads a rival's mention as such; usually the same names as your competitor keywords.
|
|
992
|
+
*/
|
|
993
|
+
competitors: Array<string>;
|
|
994
|
+
/**
|
|
995
|
+
* Free-text rules for the classifier: what counts as relevant for you and what never does ("posts about our API, never job listings"). The second biggest lever after the description.
|
|
996
|
+
*/
|
|
997
|
+
guidelines: string | null;
|
|
868
998
|
/**
|
|
869
999
|
* The text the classifier reads. Composed from the fields above unless you override it.
|
|
870
1000
|
*/
|
|
871
1001
|
context: string;
|
|
872
1002
|
};
|
|
1003
|
+
type Whoami = {
|
|
1004
|
+
/**
|
|
1005
|
+
* The workspace this credential acts on.
|
|
1006
|
+
*/
|
|
1007
|
+
workspace: {
|
|
1008
|
+
/**
|
|
1009
|
+
* Workspace id (org_...).
|
|
1010
|
+
*/
|
|
1011
|
+
id: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* The workspace name, as the dashboard shows it.
|
|
1014
|
+
*/
|
|
1015
|
+
name: string;
|
|
1016
|
+
};
|
|
1017
|
+
/**
|
|
1018
|
+
* The credential.
|
|
1019
|
+
*/
|
|
1020
|
+
auth: {
|
|
1021
|
+
/**
|
|
1022
|
+
* How the request authenticated: an API key, an OAuth access token (MCP sign-in), or the dashboard session.
|
|
1023
|
+
*/
|
|
1024
|
+
kind: 'api_key' | 'oauth' | 'session';
|
|
1025
|
+
/**
|
|
1026
|
+
* What the credential may do: read (GET only) or write.
|
|
1027
|
+
*/
|
|
1028
|
+
scope: 'read' | 'write';
|
|
1029
|
+
/**
|
|
1030
|
+
* The key id (key_...) when authenticated with an API key; null otherwise.
|
|
1031
|
+
*/
|
|
1032
|
+
apiKeyId: string | null;
|
|
1033
|
+
/**
|
|
1034
|
+
* When an API key stops working; null for a key that never expires, an OAuth token or a session.
|
|
1035
|
+
*/
|
|
1036
|
+
expiresAt: string | null;
|
|
1037
|
+
};
|
|
1038
|
+
/**
|
|
1039
|
+
* The person behind an OAuth token or a session; null for an API key, which has no person behind it.
|
|
1040
|
+
*/
|
|
1041
|
+
user: {
|
|
1042
|
+
/**
|
|
1043
|
+
* User id, what assigneeId and ownerId take.
|
|
1044
|
+
*/
|
|
1045
|
+
id: string;
|
|
1046
|
+
/**
|
|
1047
|
+
* The account's email address.
|
|
1048
|
+
*/
|
|
1049
|
+
email: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* The name on the account; null when they never set one.
|
|
1052
|
+
*/
|
|
1053
|
+
name: string | null;
|
|
1054
|
+
} | null;
|
|
1055
|
+
};
|
|
1056
|
+
type Member = {
|
|
1057
|
+
/**
|
|
1058
|
+
* Membership id (mem_...), what DELETE /v1/members/{id} takes.
|
|
1059
|
+
*/
|
|
1060
|
+
id: string;
|
|
1061
|
+
/**
|
|
1062
|
+
* The person's user id, what assigneeId and ownerId take.
|
|
1063
|
+
*/
|
|
1064
|
+
userId: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* The account's email address.
|
|
1067
|
+
*/
|
|
1068
|
+
email: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* The name on the account; null when they never set one.
|
|
1071
|
+
*/
|
|
1072
|
+
name: string | null;
|
|
1073
|
+
/**
|
|
1074
|
+
* owner: everything, billing included. admin: manages the team. member: works the feed.
|
|
1075
|
+
*/
|
|
1076
|
+
role: 'owner' | 'admin' | 'member';
|
|
1077
|
+
/**
|
|
1078
|
+
* When the membership was created.
|
|
1079
|
+
*/
|
|
1080
|
+
joinedAt: string;
|
|
1081
|
+
};
|
|
1082
|
+
type Invitation = {
|
|
1083
|
+
/**
|
|
1084
|
+
* Invitation id (inv_...).
|
|
1085
|
+
*/
|
|
1086
|
+
id: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* The invited address, lowercased.
|
|
1089
|
+
*/
|
|
1090
|
+
email: string;
|
|
1091
|
+
/**
|
|
1092
|
+
* The role they join with.
|
|
1093
|
+
*/
|
|
1094
|
+
role: 'owner' | 'admin' | 'member';
|
|
1095
|
+
/**
|
|
1096
|
+
* Who sent it; an API key invites on behalf of the oldest owner.
|
|
1097
|
+
*/
|
|
1098
|
+
invitedBy: {
|
|
1099
|
+
id: string;
|
|
1100
|
+
email: string;
|
|
1101
|
+
name: string | null;
|
|
1102
|
+
} | null;
|
|
1103
|
+
/**
|
|
1104
|
+
* Invitations last 48 hours; an expired one is no longer listed.
|
|
1105
|
+
*/
|
|
1106
|
+
expiresAt: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* When the invitation was sent.
|
|
1109
|
+
*/
|
|
1110
|
+
createdAt: string;
|
|
1111
|
+
};
|
|
1112
|
+
type UsageSummary = {
|
|
1113
|
+
/**
|
|
1114
|
+
* The prepaid wallet.
|
|
1115
|
+
*/
|
|
1116
|
+
balance: {
|
|
1117
|
+
/**
|
|
1118
|
+
* Ledger balance: every credit minus every settled debit.
|
|
1119
|
+
*/
|
|
1120
|
+
cents: number;
|
|
1121
|
+
/**
|
|
1122
|
+
* Mentions matched since the last daily settlement, priced but not yet debited.
|
|
1123
|
+
*/
|
|
1124
|
+
pendingCents: number;
|
|
1125
|
+
/**
|
|
1126
|
+
* cents minus pendingCents: what the stop rule and the keyword gate look at.
|
|
1127
|
+
*/
|
|
1128
|
+
effectiveCents: number;
|
|
1129
|
+
currency: 'USD';
|
|
1130
|
+
};
|
|
1131
|
+
/**
|
|
1132
|
+
* How fast the balance goes.
|
|
1133
|
+
*/
|
|
1134
|
+
burn: {
|
|
1135
|
+
/**
|
|
1136
|
+
* Average daily debit over the last 7 days (or since the workspace was created).
|
|
1137
|
+
*/
|
|
1138
|
+
perDayCents: number;
|
|
1139
|
+
/**
|
|
1140
|
+
* effectiveCents divided by perDayCents; null when nothing is burning.
|
|
1141
|
+
*/
|
|
1142
|
+
daysLeft: number | null;
|
|
1143
|
+
};
|
|
1144
|
+
/**
|
|
1145
|
+
* Keywords against the wallet.
|
|
1146
|
+
*/
|
|
1147
|
+
keywords: {
|
|
1148
|
+
/**
|
|
1149
|
+
* Unmuted keywords, the ones charged daily.
|
|
1150
|
+
*/
|
|
1151
|
+
active: number;
|
|
1152
|
+
/**
|
|
1153
|
+
* Keywords the wallet paused for lack of balance; a top-up resumes them.
|
|
1154
|
+
*/
|
|
1155
|
+
paused: number;
|
|
1156
|
+
/**
|
|
1157
|
+
* How many keywords the workspace may run right now: the self-serve ceiling when the balance covers one more keyword-day, else 0.
|
|
1158
|
+
*/
|
|
1159
|
+
limit: number;
|
|
1160
|
+
/**
|
|
1161
|
+
* What one more day of the active keywords costs.
|
|
1162
|
+
*/
|
|
1163
|
+
dayCents: number;
|
|
1164
|
+
};
|
|
1165
|
+
/**
|
|
1166
|
+
* Matched mentions, the other thing that bills.
|
|
1167
|
+
*/
|
|
1168
|
+
mentions: {
|
|
1169
|
+
/**
|
|
1170
|
+
* Matches recorded today (UTC), relevant or not: every one bills.
|
|
1171
|
+
*/
|
|
1172
|
+
today: number;
|
|
1173
|
+
/**
|
|
1174
|
+
* Matches recorded in the last 30 days.
|
|
1175
|
+
*/
|
|
1176
|
+
last30d: number;
|
|
1177
|
+
};
|
|
1178
|
+
/**
|
|
1179
|
+
* The wallet paused tracking; a top-up that covers a day of every keyword resumes it.
|
|
1180
|
+
*/
|
|
1181
|
+
stopped: boolean;
|
|
1182
|
+
/**
|
|
1183
|
+
* Running, and the effective balance is at or under 20 percent of the last credit.
|
|
1184
|
+
*/
|
|
1185
|
+
lowBalance: boolean;
|
|
1186
|
+
/**
|
|
1187
|
+
* Newest paid top-up; null before the first.
|
|
1188
|
+
*/
|
|
1189
|
+
lastTopUpAt: string | null;
|
|
1190
|
+
};
|
|
873
1191
|
type Alert = {
|
|
874
1192
|
/**
|
|
875
1193
|
* Alert id (feed_...).
|
|
@@ -878,9 +1196,9 @@ type Alert = {
|
|
|
878
1196
|
name: string;
|
|
879
1197
|
enabled: boolean;
|
|
880
1198
|
/**
|
|
881
|
-
* instant: each matching mention as it happens. daily: one digest at the scheduled local time.
|
|
1199
|
+
* instant: each matching mention as it happens. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
|
|
882
1200
|
*/
|
|
883
|
-
mode: 'instant' | 'daily';
|
|
1201
|
+
mode: 'instant' | 'daily' | 'weekly';
|
|
884
1202
|
filter: {
|
|
885
1203
|
/**
|
|
886
1204
|
* Only these keywords.
|
|
@@ -894,12 +1212,16 @@ type Alert = {
|
|
|
894
1212
|
* Only mentions scored at least this; unclassified ones never pass.
|
|
895
1213
|
*/
|
|
896
1214
|
minRelevance?: number;
|
|
1215
|
+
/**
|
|
1216
|
+
* Only mentions whose classifier confidence is at least this, 0 to 1. A mention without a confidence never passes.
|
|
1217
|
+
*/
|
|
1218
|
+
minConfidence?: number;
|
|
897
1219
|
/**
|
|
898
1220
|
* Only these sentiments.
|
|
899
1221
|
*/
|
|
900
1222
|
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
901
1223
|
/**
|
|
902
|
-
* At least one of these
|
|
1224
|
+
* At least one of these intent or topic tags.
|
|
903
1225
|
*/
|
|
904
1226
|
intents?: Array<string>;
|
|
905
1227
|
/**
|
|
@@ -918,15 +1240,27 @@ type Alert = {
|
|
|
918
1240
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
919
1241
|
*/
|
|
920
1242
|
linkHosts?: Array<string>;
|
|
1243
|
+
/**
|
|
1244
|
+
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
1245
|
+
*/
|
|
1246
|
+
languages?: Array<string>;
|
|
1247
|
+
/**
|
|
1248
|
+
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
1249
|
+
*/
|
|
1250
|
+
automated?: boolean;
|
|
921
1251
|
};
|
|
922
1252
|
/**
|
|
923
|
-
* Daily alerts only.
|
|
1253
|
+
* Daily and weekly alerts only.
|
|
924
1254
|
*/
|
|
925
1255
|
schedule: {
|
|
926
1256
|
hour: number;
|
|
927
1257
|
minute?: number;
|
|
928
1258
|
timezone: string;
|
|
929
1259
|
skipEmpty?: boolean;
|
|
1260
|
+
/**
|
|
1261
|
+
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
1262
|
+
*/
|
|
1263
|
+
weekday?: number;
|
|
930
1264
|
} | null;
|
|
931
1265
|
/**
|
|
932
1266
|
* Event name carried in webhook payloads; the mode default unless you set one.
|
|
@@ -953,7 +1287,7 @@ type Alert = {
|
|
|
953
1287
|
*/
|
|
954
1288
|
lastSentAt: string | null;
|
|
955
1289
|
/**
|
|
956
|
-
* Daily alerts: the next digest; null when disabled or instant.
|
|
1290
|
+
* Daily and weekly alerts: the next digest; null when disabled or instant.
|
|
957
1291
|
*/
|
|
958
1292
|
nextRunAt: string | null;
|
|
959
1293
|
};
|
|
@@ -1186,20 +1520,20 @@ type AnalyticsSeries = {
|
|
|
1186
1520
|
*/
|
|
1187
1521
|
timezone: string;
|
|
1188
1522
|
/**
|
|
1189
|
-
* Point granularity: day,
|
|
1523
|
+
* Point granularity used: hour, day, week (Monday to Sunday) or month.
|
|
1190
1524
|
*/
|
|
1191
|
-
bucket: 'day' | 'week';
|
|
1525
|
+
bucket: 'hour' | 'day' | 'week' | 'month';
|
|
1192
1526
|
};
|
|
1193
1527
|
/**
|
|
1194
1528
|
* One item per series, most matched first; a single "total" item when not split.
|
|
1195
1529
|
*/
|
|
1196
1530
|
data: Array<{
|
|
1197
1531
|
/**
|
|
1198
|
-
* Platform name, keyword id, "total" for the unsplit series, or "other" for the keys beyond the top 20.
|
|
1532
|
+
* Platform name, keyword id, sentiment (positive, neutral, negative, unclassified), "total" for the unsplit series, or "other" for the keys beyond the top 20.
|
|
1199
1533
|
*/
|
|
1200
1534
|
key: string;
|
|
1201
1535
|
/**
|
|
1202
|
-
* Readable name: the platform, the keyword term, "Total" or "Other".
|
|
1536
|
+
* Readable name: the platform, the keyword term, the sentiment, "Total" or "Other".
|
|
1203
1537
|
*/
|
|
1204
1538
|
label: string;
|
|
1205
1539
|
/**
|
|
@@ -1224,7 +1558,7 @@ type AnalyticsSeries = {
|
|
|
1224
1558
|
*/
|
|
1225
1559
|
points: Array<{
|
|
1226
1560
|
/**
|
|
1227
|
-
* The day,
|
|
1561
|
+
* The bucket start in `timezone`: the day (YYYY-MM-DD), the Monday of the week, the first of the month, or the hour as YYYY-MM-DDTHH:00.
|
|
1228
1562
|
*/
|
|
1229
1563
|
date: string;
|
|
1230
1564
|
/**
|
|
@@ -1258,11 +1592,11 @@ type AnalyticsSeries = {
|
|
|
1258
1592
|
*/
|
|
1259
1593
|
previous: Array<{
|
|
1260
1594
|
/**
|
|
1261
|
-
* Platform name, keyword id, "total" for the unsplit series, or "other" for the keys beyond the top 20.
|
|
1595
|
+
* Platform name, keyword id, sentiment (positive, neutral, negative, unclassified), "total" for the unsplit series, or "other" for the keys beyond the top 20.
|
|
1262
1596
|
*/
|
|
1263
1597
|
key: string;
|
|
1264
1598
|
/**
|
|
1265
|
-
* Readable name: the platform, the keyword term, "Total" or "Other".
|
|
1599
|
+
* Readable name: the platform, the keyword term, the sentiment, "Total" or "Other".
|
|
1266
1600
|
*/
|
|
1267
1601
|
label: string;
|
|
1268
1602
|
/**
|
|
@@ -1287,7 +1621,7 @@ type AnalyticsSeries = {
|
|
|
1287
1621
|
*/
|
|
1288
1622
|
points: Array<{
|
|
1289
1623
|
/**
|
|
1290
|
-
* The day,
|
|
1624
|
+
* The bucket start in `timezone`: the day (YYYY-MM-DD), the Monday of the week, the first of the month, or the hour as YYYY-MM-DDTHH:00.
|
|
1291
1625
|
*/
|
|
1292
1626
|
date: string;
|
|
1293
1627
|
/**
|
|
@@ -1342,7 +1676,7 @@ type AnalyticsBreakdown = {
|
|
|
1342
1676
|
/**
|
|
1343
1677
|
* The dimension the rows are grouped by.
|
|
1344
1678
|
*/
|
|
1345
|
-
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person';
|
|
1679
|
+
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language';
|
|
1346
1680
|
/**
|
|
1347
1681
|
* Most matched first, at most 50 groups. by=hour is chronological and unlimited (168 cells at most).
|
|
1348
1682
|
*/
|
|
@@ -1821,6 +2155,35 @@ type ListKeywordsResponses = {
|
|
|
1821
2155
|
* Platforms this keyword is tracked on; null means every platform.
|
|
1822
2156
|
*/
|
|
1823
2157
|
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
2158
|
+
/**
|
|
2159
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
2160
|
+
*/
|
|
2161
|
+
context: string | null;
|
|
2162
|
+
/**
|
|
2163
|
+
* Matching rules applied before a mention is stored; a rejected post is never billed.
|
|
2164
|
+
*/
|
|
2165
|
+
matching: {
|
|
2166
|
+
/**
|
|
2167
|
+
* The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
|
|
2168
|
+
*/
|
|
2169
|
+
requiredTerms: Array<string>;
|
|
2170
|
+
/**
|
|
2171
|
+
* any: at least one required term must appear. all: every one must.
|
|
2172
|
+
*/
|
|
2173
|
+
requiredMode: 'any' | 'all';
|
|
2174
|
+
/**
|
|
2175
|
+
* A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
|
|
2176
|
+
*/
|
|
2177
|
+
excludedTerms: Array<string>;
|
|
2178
|
+
/**
|
|
2179
|
+
* Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
|
|
2180
|
+
*/
|
|
2181
|
+
excludedAuthors: Array<string>;
|
|
2182
|
+
/**
|
|
2183
|
+
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
2184
|
+
*/
|
|
2185
|
+
caseSensitive: boolean;
|
|
2186
|
+
};
|
|
1824
2187
|
/**
|
|
1825
2188
|
* Computed over this workspace's matches.
|
|
1826
2189
|
*/
|
|
@@ -1841,6 +2204,19 @@ type ListKeywordsResponses = {
|
|
|
1841
2204
|
* Newest matched post; null until the first one.
|
|
1842
2205
|
*/
|
|
1843
2206
|
lastMentionAt: string | null;
|
|
2207
|
+
/**
|
|
2208
|
+
* Your verdicts on this keyword's mentions (PATCH /v1/mentions/{id} relevant).
|
|
2209
|
+
*/
|
|
2210
|
+
feedback: {
|
|
2211
|
+
/**
|
|
2212
|
+
* Mentions a person marked relevant.
|
|
2213
|
+
*/
|
|
2214
|
+
relevant: number;
|
|
2215
|
+
/**
|
|
2216
|
+
* Mentions a person marked not relevant: the noise the classifier let through.
|
|
2217
|
+
*/
|
|
2218
|
+
notRelevant: number;
|
|
2219
|
+
};
|
|
1844
2220
|
};
|
|
1845
2221
|
/**
|
|
1846
2222
|
* Poll health per platform polled on a schedule. Live feeds (Bluesky) have no entry.
|
|
@@ -1881,6 +2257,35 @@ type CreateKeywordData = {
|
|
|
1881
2257
|
* Platforms to track it on; omit or null for every platform.
|
|
1882
2258
|
*/
|
|
1883
2259
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
2260
|
+
/**
|
|
2261
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
2262
|
+
*/
|
|
2263
|
+
context?: string | null;
|
|
2264
|
+
/**
|
|
2265
|
+
* Omitted fields are untouched; an empty list clears one.
|
|
2266
|
+
*/
|
|
2267
|
+
matching?: {
|
|
2268
|
+
/**
|
|
2269
|
+
* The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
|
|
2270
|
+
*/
|
|
2271
|
+
requiredTerms?: Array<string>;
|
|
2272
|
+
/**
|
|
2273
|
+
* any: at least one required term must appear. all: every one must.
|
|
2274
|
+
*/
|
|
2275
|
+
requiredMode?: 'any' | 'all';
|
|
2276
|
+
/**
|
|
2277
|
+
* A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
|
|
2278
|
+
*/
|
|
2279
|
+
excludedTerms?: Array<string>;
|
|
2280
|
+
/**
|
|
2281
|
+
* Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
|
|
2282
|
+
*/
|
|
2283
|
+
excludedAuthors?: Array<string>;
|
|
2284
|
+
/**
|
|
2285
|
+
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
2286
|
+
*/
|
|
2287
|
+
caseSensitive?: boolean;
|
|
2288
|
+
};
|
|
1884
2289
|
};
|
|
1885
2290
|
path?: never;
|
|
1886
2291
|
query?: never;
|
|
@@ -1971,6 +2376,10 @@ type UpdateKeywordData = {
|
|
|
1971
2376
|
* Omitted fields are untouched.
|
|
1972
2377
|
*/
|
|
1973
2378
|
body: {
|
|
2379
|
+
/**
|
|
2380
|
+
* Reclassify it as brand, competitor or topic.
|
|
2381
|
+
*/
|
|
2382
|
+
kind?: 'brand' | 'competitor' | 'topic';
|
|
1974
2383
|
/**
|
|
1975
2384
|
* A muted keyword stops polling and matching; its mentions stay.
|
|
1976
2385
|
*/
|
|
@@ -1979,6 +2388,35 @@ type UpdateKeywordData = {
|
|
|
1979
2388
|
* Replaces the platform list; null means every platform.
|
|
1980
2389
|
*/
|
|
1981
2390
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
2391
|
+
/**
|
|
2392
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
2393
|
+
*/
|
|
2394
|
+
context?: string | null;
|
|
2395
|
+
/**
|
|
2396
|
+
* Omitted fields are untouched; an empty list clears one.
|
|
2397
|
+
*/
|
|
2398
|
+
matching?: {
|
|
2399
|
+
/**
|
|
2400
|
+
* The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
|
|
2401
|
+
*/
|
|
2402
|
+
requiredTerms?: Array<string>;
|
|
2403
|
+
/**
|
|
2404
|
+
* any: at least one required term must appear. all: every one must.
|
|
2405
|
+
*/
|
|
2406
|
+
requiredMode?: 'any' | 'all';
|
|
2407
|
+
/**
|
|
2408
|
+
* A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
|
|
2409
|
+
*/
|
|
2410
|
+
excludedTerms?: Array<string>;
|
|
2411
|
+
/**
|
|
2412
|
+
* Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
|
|
2413
|
+
*/
|
|
2414
|
+
excludedAuthors?: Array<string>;
|
|
2415
|
+
/**
|
|
2416
|
+
* true: the term must appear in the case it was typed (RAG, never rag). Default false.
|
|
2417
|
+
*/
|
|
2418
|
+
caseSensitive?: boolean;
|
|
2419
|
+
};
|
|
1982
2420
|
};
|
|
1983
2421
|
path: {
|
|
1984
2422
|
/**
|
|
@@ -2011,6 +2449,79 @@ type UpdateKeywordResponses = {
|
|
|
2011
2449
|
200: Keyword;
|
|
2012
2450
|
};
|
|
2013
2451
|
type UpdateKeywordResponse = UpdateKeywordResponses[keyof UpdateKeywordResponses];
|
|
2452
|
+
type GetFiltersData = {
|
|
2453
|
+
body?: never;
|
|
2454
|
+
path?: never;
|
|
2455
|
+
query?: never;
|
|
2456
|
+
url: '/v1/filters';
|
|
2457
|
+
};
|
|
2458
|
+
type GetFiltersErrors = {
|
|
2459
|
+
/**
|
|
2460
|
+
* Missing or invalid API key
|
|
2461
|
+
*/
|
|
2462
|
+
401: ErrorResponse;
|
|
2463
|
+
};
|
|
2464
|
+
type GetFiltersError = GetFiltersErrors[keyof GetFiltersErrors];
|
|
2465
|
+
type GetFiltersResponses = {
|
|
2466
|
+
/**
|
|
2467
|
+
* The workspace filters
|
|
2468
|
+
*/
|
|
2469
|
+
200: WorkspaceFilters;
|
|
2470
|
+
};
|
|
2471
|
+
type GetFiltersResponse = GetFiltersResponses[keyof GetFiltersResponses];
|
|
2472
|
+
type UpdateFiltersData = {
|
|
2473
|
+
/**
|
|
2474
|
+
* Omitted fields are untouched; an empty list clears one.
|
|
2475
|
+
*/
|
|
2476
|
+
body: {
|
|
2477
|
+
/**
|
|
2478
|
+
* Replaces the list; [] clears it.
|
|
2479
|
+
*/
|
|
2480
|
+
excludedTerms?: Array<string>;
|
|
2481
|
+
/**
|
|
2482
|
+
* Replaces the list; [] clears it.
|
|
2483
|
+
*/
|
|
2484
|
+
excludedAuthors?: Array<string>;
|
|
2485
|
+
/**
|
|
2486
|
+
* Replaces the list; [] clears it.
|
|
2487
|
+
*/
|
|
2488
|
+
excludedRepos?: Array<string>;
|
|
2489
|
+
/**
|
|
2490
|
+
* Reddit only; an omitted list is untouched.
|
|
2491
|
+
*/
|
|
2492
|
+
subreddits?: {
|
|
2493
|
+
/**
|
|
2494
|
+
* Replaces the allowlist; [] clears it.
|
|
2495
|
+
*/
|
|
2496
|
+
only?: Array<string>;
|
|
2497
|
+
/**
|
|
2498
|
+
* Replaces the deny list; [] clears it.
|
|
2499
|
+
*/
|
|
2500
|
+
excluded?: Array<string>;
|
|
2501
|
+
};
|
|
2502
|
+
};
|
|
2503
|
+
path?: never;
|
|
2504
|
+
query?: never;
|
|
2505
|
+
url: '/v1/filters';
|
|
2506
|
+
};
|
|
2507
|
+
type UpdateFiltersErrors = {
|
|
2508
|
+
/**
|
|
2509
|
+
* An entry is not a term, an author, a repository or a subreddit
|
|
2510
|
+
*/
|
|
2511
|
+
400: ErrorResponse;
|
|
2512
|
+
/**
|
|
2513
|
+
* Missing or invalid API key
|
|
2514
|
+
*/
|
|
2515
|
+
401: ErrorResponse;
|
|
2516
|
+
};
|
|
2517
|
+
type UpdateFiltersError = UpdateFiltersErrors[keyof UpdateFiltersErrors];
|
|
2518
|
+
type UpdateFiltersResponses = {
|
|
2519
|
+
/**
|
|
2520
|
+
* The updated filters
|
|
2521
|
+
*/
|
|
2522
|
+
200: WorkspaceFilters;
|
|
2523
|
+
};
|
|
2524
|
+
type UpdateFiltersResponse = UpdateFiltersResponses[keyof UpdateFiltersResponses];
|
|
2014
2525
|
type GetMentionData = {
|
|
2015
2526
|
body?: never;
|
|
2016
2527
|
path: {
|
|
@@ -2061,6 +2572,14 @@ type UpdateMentionData = {
|
|
|
2061
2572
|
* Internal note; null or empty clears it.
|
|
2062
2573
|
*/
|
|
2063
2574
|
note?: string | null;
|
|
2575
|
+
/**
|
|
2576
|
+
* Your verdict on relevance, correcting the classifier: true sets relevance to 100 and puts a filtered mention back in the relevant feed, false sets it to 0 and takes it out; null withdraws the verdict and restores the classifier's score. Never billed or unbilled. A mention still being classified answers 409 classification_pending.
|
|
2577
|
+
*/
|
|
2578
|
+
relevant?: boolean | null;
|
|
2579
|
+
/**
|
|
2580
|
+
* Your corrected sentiment; null withdraws the correction and restores the classifier's.
|
|
2581
|
+
*/
|
|
2582
|
+
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
2064
2583
|
};
|
|
2065
2584
|
path: {
|
|
2066
2585
|
/**
|
|
@@ -2084,6 +2603,10 @@ type UpdateMentionErrors = {
|
|
|
2084
2603
|
* Mention not found
|
|
2085
2604
|
*/
|
|
2086
2605
|
404: ErrorResponse;
|
|
2606
|
+
/**
|
|
2607
|
+
* A verdict on a mention the classifier has not scored yet (classification_pending)
|
|
2608
|
+
*/
|
|
2609
|
+
409: ErrorResponse;
|
|
2087
2610
|
};
|
|
2088
2611
|
type UpdateMentionError = UpdateMentionErrors[keyof UpdateMentionErrors];
|
|
2089
2612
|
type UpdateMentionResponses = {
|
|
@@ -2118,7 +2641,7 @@ type SearchMentionsData = {
|
|
|
2118
2641
|
*/
|
|
2119
2642
|
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
2120
2643
|
/**
|
|
2121
|
-
* Only mentions carrying this intent (buy_intent, question, complaint, praise, comparison).
|
|
2644
|
+
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
|
|
2122
2645
|
*/
|
|
2123
2646
|
intent?: string;
|
|
2124
2647
|
/**
|
|
@@ -2149,10 +2672,26 @@ type SearchMentionsData = {
|
|
|
2149
2672
|
* Only mentions scored at least this; unclassified ones are excluded.
|
|
2150
2673
|
*/
|
|
2151
2674
|
minRelevance?: number | null;
|
|
2675
|
+
/**
|
|
2676
|
+
* Only mentions whose classifier confidence is at least this, 0 to 1. Mentions without a confidence are excluded.
|
|
2677
|
+
*/
|
|
2678
|
+
minConfidence?: number | null;
|
|
2152
2679
|
/**
|
|
2153
2680
|
* Only authors with at least this many followers. Unknown reach never passes.
|
|
2154
2681
|
*/
|
|
2155
2682
|
minFollowers?: number | null;
|
|
2683
|
+
/**
|
|
2684
|
+
* Only authors with at most this many followers. Unknown reach never passes.
|
|
2685
|
+
*/
|
|
2686
|
+
maxFollowers?: number | null;
|
|
2687
|
+
/**
|
|
2688
|
+
* true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
|
|
2689
|
+
*/
|
|
2690
|
+
isReply?: boolean;
|
|
2691
|
+
/**
|
|
2692
|
+
* Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404.
|
|
2693
|
+
*/
|
|
2694
|
+
alertId?: string;
|
|
2156
2695
|
/**
|
|
2157
2696
|
* Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
|
|
2158
2697
|
*/
|
|
@@ -2186,11 +2725,11 @@ type SearchMentionsData = {
|
|
|
2186
2725
|
*/
|
|
2187
2726
|
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
2188
2727
|
/**
|
|
2189
|
-
* Only mentions carrying any of these
|
|
2728
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
2190
2729
|
*/
|
|
2191
2730
|
intents?: Array<string> | null;
|
|
2192
2731
|
/**
|
|
2193
|
-
* Never mentions carrying these
|
|
2732
|
+
* Never mentions carrying these intent or topic tags.
|
|
2194
2733
|
*/
|
|
2195
2734
|
notIntents?: Array<string> | null;
|
|
2196
2735
|
/**
|
|
@@ -2202,7 +2741,15 @@ type SearchMentionsData = {
|
|
|
2202
2741
|
*/
|
|
2203
2742
|
notTags?: Array<string> | null;
|
|
2204
2743
|
/**
|
|
2205
|
-
*
|
|
2744
|
+
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
2745
|
+
*/
|
|
2746
|
+
languages?: Array<string>;
|
|
2747
|
+
/**
|
|
2748
|
+
* Never posts in these languages. A post whose language is unknown still passes.
|
|
2749
|
+
*/
|
|
2750
|
+
notLanguages?: Array<string>;
|
|
2751
|
+
/**
|
|
2752
|
+
* Substring search in the post text or the author's name.
|
|
2206
2753
|
*/
|
|
2207
2754
|
q?: string;
|
|
2208
2755
|
/**
|
|
@@ -2277,7 +2824,7 @@ type ExportMentionsCsvData = {
|
|
|
2277
2824
|
*/
|
|
2278
2825
|
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
2279
2826
|
/**
|
|
2280
|
-
* Only mentions carrying this intent (buy_intent, question, complaint, praise, comparison).
|
|
2827
|
+
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
|
|
2281
2828
|
*/
|
|
2282
2829
|
intent?: string;
|
|
2283
2830
|
/**
|
|
@@ -2308,10 +2855,26 @@ type ExportMentionsCsvData = {
|
|
|
2308
2855
|
* Only mentions scored at least this; unclassified ones are excluded.
|
|
2309
2856
|
*/
|
|
2310
2857
|
minRelevance?: number | null;
|
|
2858
|
+
/**
|
|
2859
|
+
* Only mentions whose classifier confidence is at least this, 0 to 1. Mentions without a confidence are excluded.
|
|
2860
|
+
*/
|
|
2861
|
+
minConfidence?: number | null;
|
|
2311
2862
|
/**
|
|
2312
2863
|
* Only authors with at least this many followers. Unknown reach never passes.
|
|
2313
2864
|
*/
|
|
2314
2865
|
minFollowers?: number | null;
|
|
2866
|
+
/**
|
|
2867
|
+
* Only authors with at most this many followers. Unknown reach never passes.
|
|
2868
|
+
*/
|
|
2869
|
+
maxFollowers?: number | null;
|
|
2870
|
+
/**
|
|
2871
|
+
* true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
|
|
2872
|
+
*/
|
|
2873
|
+
isReply?: boolean;
|
|
2874
|
+
/**
|
|
2875
|
+
* Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404.
|
|
2876
|
+
*/
|
|
2877
|
+
alertId?: string;
|
|
2315
2878
|
/**
|
|
2316
2879
|
* Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
|
|
2317
2880
|
*/
|
|
@@ -2345,11 +2908,11 @@ type ExportMentionsCsvData = {
|
|
|
2345
2908
|
*/
|
|
2346
2909
|
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
2347
2910
|
/**
|
|
2348
|
-
* Only mentions carrying any of these
|
|
2911
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
2349
2912
|
*/
|
|
2350
2913
|
intents?: Array<string> | null;
|
|
2351
2914
|
/**
|
|
2352
|
-
* Never mentions carrying these
|
|
2915
|
+
* Never mentions carrying these intent or topic tags.
|
|
2353
2916
|
*/
|
|
2354
2917
|
notIntents?: Array<string> | null;
|
|
2355
2918
|
/**
|
|
@@ -2361,7 +2924,15 @@ type ExportMentionsCsvData = {
|
|
|
2361
2924
|
*/
|
|
2362
2925
|
notTags?: Array<string> | null;
|
|
2363
2926
|
/**
|
|
2364
|
-
*
|
|
2927
|
+
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
2928
|
+
*/
|
|
2929
|
+
languages?: Array<string>;
|
|
2930
|
+
/**
|
|
2931
|
+
* Never posts in these languages. A post whose language is unknown still passes.
|
|
2932
|
+
*/
|
|
2933
|
+
notLanguages?: Array<string>;
|
|
2934
|
+
/**
|
|
2935
|
+
* Substring search in the post text or the author's name.
|
|
2365
2936
|
*/
|
|
2366
2937
|
q?: string;
|
|
2367
2938
|
/**
|
|
@@ -3616,6 +4187,18 @@ type UpdateCompanyData = {
|
|
|
3616
4187
|
x?: string | null;
|
|
3617
4188
|
linkedin?: string | null;
|
|
3618
4189
|
};
|
|
4190
|
+
/**
|
|
4191
|
+
* The company website; null clears it.
|
|
4192
|
+
*/
|
|
4193
|
+
website?: string | null;
|
|
4194
|
+
/**
|
|
4195
|
+
* Replaces the whole list; [] clears it.
|
|
4196
|
+
*/
|
|
4197
|
+
competitors?: Array<string>;
|
|
4198
|
+
/**
|
|
4199
|
+
* Free-text rules for the classifier; null clears them.
|
|
4200
|
+
*/
|
|
4201
|
+
guidelines?: string | null;
|
|
3619
4202
|
/**
|
|
3620
4203
|
* Overrides the composed context until the next profile edit.
|
|
3621
4204
|
*/
|
|
@@ -3683,6 +4266,10 @@ type ListApiKeysResponses = {
|
|
|
3683
4266
|
* ISO 8601 timestamp, UTC.
|
|
3684
4267
|
*/
|
|
3685
4268
|
lastUsedAt: string | null;
|
|
4269
|
+
/**
|
|
4270
|
+
* When the key stops working; null for a key that never expires. An expired key stays listed until revoked.
|
|
4271
|
+
*/
|
|
4272
|
+
expiresAt: string | null;
|
|
3686
4273
|
}>;
|
|
3687
4274
|
};
|
|
3688
4275
|
};
|
|
@@ -3697,12 +4284,20 @@ type CreateApiKeyData = {
|
|
|
3697
4284
|
* read: GET only. write: everything.
|
|
3698
4285
|
*/
|
|
3699
4286
|
scope?: 'read' | 'write';
|
|
4287
|
+
/**
|
|
4288
|
+
* When the key stops working (ISO 8601, or epoch ms), for a key handed to a script or a contractor. Must be in the future. Omit or null for a key that never expires.
|
|
4289
|
+
*/
|
|
4290
|
+
expiresAt?: string;
|
|
3700
4291
|
};
|
|
3701
4292
|
path?: never;
|
|
3702
4293
|
query?: never;
|
|
3703
4294
|
url: '/v1/api-keys';
|
|
3704
4295
|
};
|
|
3705
4296
|
type CreateApiKeyErrors = {
|
|
4297
|
+
/**
|
|
4298
|
+
* expiresAt is not in the future
|
|
4299
|
+
*/
|
|
4300
|
+
400: ErrorResponse;
|
|
3706
4301
|
/**
|
|
3707
4302
|
* Missing or invalid API key
|
|
3708
4303
|
*/
|
|
@@ -3735,6 +4330,10 @@ type CreateApiKeyResponses = {
|
|
|
3735
4330
|
* ISO 8601 timestamp, UTC.
|
|
3736
4331
|
*/
|
|
3737
4332
|
lastUsedAt: string | null;
|
|
4333
|
+
/**
|
|
4334
|
+
* When the key stops working; null for a key that never expires. An expired key stays listed until revoked.
|
|
4335
|
+
*/
|
|
4336
|
+
expiresAt: string | null;
|
|
3738
4337
|
/**
|
|
3739
4338
|
* The full key. Shown once; store it now.
|
|
3740
4339
|
*/
|
|
@@ -3771,6 +4370,201 @@ type RevokeApiKeyResponses = {
|
|
|
3771
4370
|
204: void;
|
|
3772
4371
|
};
|
|
3773
4372
|
type RevokeApiKeyResponse = RevokeApiKeyResponses[keyof RevokeApiKeyResponses];
|
|
4373
|
+
type WhoamiData = {
|
|
4374
|
+
body?: never;
|
|
4375
|
+
path?: never;
|
|
4376
|
+
query?: never;
|
|
4377
|
+
url: '/v1/whoami';
|
|
4378
|
+
};
|
|
4379
|
+
type WhoamiErrors = {
|
|
4380
|
+
/**
|
|
4381
|
+
* Missing or invalid API key
|
|
4382
|
+
*/
|
|
4383
|
+
401: ErrorResponse;
|
|
4384
|
+
};
|
|
4385
|
+
type WhoamiError = WhoamiErrors[keyof WhoamiErrors];
|
|
4386
|
+
type WhoamiResponses = {
|
|
4387
|
+
/**
|
|
4388
|
+
* The credential
|
|
4389
|
+
*/
|
|
4390
|
+
200: Whoami;
|
|
4391
|
+
};
|
|
4392
|
+
type WhoamiResponse = WhoamiResponses[keyof WhoamiResponses];
|
|
4393
|
+
type ListMembersData = {
|
|
4394
|
+
body?: never;
|
|
4395
|
+
path?: never;
|
|
4396
|
+
query?: never;
|
|
4397
|
+
url: '/v1/members';
|
|
4398
|
+
};
|
|
4399
|
+
type ListMembersErrors = {
|
|
4400
|
+
/**
|
|
4401
|
+
* Missing or invalid API key
|
|
4402
|
+
*/
|
|
4403
|
+
401: ErrorResponse;
|
|
4404
|
+
};
|
|
4405
|
+
type ListMembersError = ListMembersErrors[keyof ListMembersErrors];
|
|
4406
|
+
type ListMembersResponses = {
|
|
4407
|
+
/**
|
|
4408
|
+
* The members
|
|
4409
|
+
*/
|
|
4410
|
+
200: {
|
|
4411
|
+
data: Array<Member>;
|
|
4412
|
+
};
|
|
4413
|
+
};
|
|
4414
|
+
type ListMembersResponse = ListMembersResponses[keyof ListMembersResponses];
|
|
4415
|
+
type ListInvitationsData = {
|
|
4416
|
+
body?: never;
|
|
4417
|
+
path?: never;
|
|
4418
|
+
query?: never;
|
|
4419
|
+
url: '/v1/members/invitations';
|
|
4420
|
+
};
|
|
4421
|
+
type ListInvitationsErrors = {
|
|
4422
|
+
/**
|
|
4423
|
+
* Missing or invalid API key
|
|
4424
|
+
*/
|
|
4425
|
+
401: ErrorResponse;
|
|
4426
|
+
};
|
|
4427
|
+
type ListInvitationsError = ListInvitationsErrors[keyof ListInvitationsErrors];
|
|
4428
|
+
type ListInvitationsResponses = {
|
|
4429
|
+
/**
|
|
4430
|
+
* The open invitations
|
|
4431
|
+
*/
|
|
4432
|
+
200: {
|
|
4433
|
+
data: Array<Invitation>;
|
|
4434
|
+
};
|
|
4435
|
+
};
|
|
4436
|
+
type ListInvitationsResponse = ListInvitationsResponses[keyof ListInvitationsResponses];
|
|
4437
|
+
type CreateInvitationData = {
|
|
4438
|
+
body: {
|
|
4439
|
+
/**
|
|
4440
|
+
* The address to invite; it receives an email with a link to join.
|
|
4441
|
+
*/
|
|
4442
|
+
email: string;
|
|
4443
|
+
/**
|
|
4444
|
+
* The role they join with. Ownership is only handed over in the dashboard.
|
|
4445
|
+
*/
|
|
4446
|
+
role?: 'admin' | 'member';
|
|
4447
|
+
};
|
|
4448
|
+
path?: never;
|
|
4449
|
+
query?: never;
|
|
4450
|
+
url: '/v1/members/invitations';
|
|
4451
|
+
};
|
|
4452
|
+
type CreateInvitationErrors = {
|
|
4453
|
+
/**
|
|
4454
|
+
* Missing or invalid API key
|
|
4455
|
+
*/
|
|
4456
|
+
401: ErrorResponse;
|
|
4457
|
+
/**
|
|
4458
|
+
* The credential is an API key, or its person is not an owner or admin
|
|
4459
|
+
*/
|
|
4460
|
+
403: ErrorResponse;
|
|
4461
|
+
/**
|
|
4462
|
+
* The address is already a member (already_member)
|
|
4463
|
+
*/
|
|
4464
|
+
409: ErrorResponse;
|
|
4465
|
+
};
|
|
4466
|
+
type CreateInvitationError = CreateInvitationErrors[keyof CreateInvitationErrors];
|
|
4467
|
+
type CreateInvitationResponses = {
|
|
4468
|
+
/**
|
|
4469
|
+
* The open invitation this address already had
|
|
4470
|
+
*/
|
|
4471
|
+
200: Invitation;
|
|
4472
|
+
/**
|
|
4473
|
+
* The invitation, emailed
|
|
4474
|
+
*/
|
|
4475
|
+
201: Invitation;
|
|
4476
|
+
};
|
|
4477
|
+
type CreateInvitationResponse = CreateInvitationResponses[keyof CreateInvitationResponses];
|
|
4478
|
+
type RevokeInvitationData = {
|
|
4479
|
+
body?: never;
|
|
4480
|
+
path: {
|
|
4481
|
+
/**
|
|
4482
|
+
* Invitation id (inv_...).
|
|
4483
|
+
*/
|
|
4484
|
+
id: string;
|
|
4485
|
+
};
|
|
4486
|
+
query?: never;
|
|
4487
|
+
url: '/v1/members/invitations/{id}';
|
|
4488
|
+
};
|
|
4489
|
+
type RevokeInvitationErrors = {
|
|
4490
|
+
/**
|
|
4491
|
+
* Missing or invalid API key
|
|
4492
|
+
*/
|
|
4493
|
+
401: ErrorResponse;
|
|
4494
|
+
/**
|
|
4495
|
+
* The credential is an API key, or its person is not an owner or admin
|
|
4496
|
+
*/
|
|
4497
|
+
403: ErrorResponse;
|
|
4498
|
+
/**
|
|
4499
|
+
* No open invitation with that id
|
|
4500
|
+
*/
|
|
4501
|
+
404: ErrorResponse;
|
|
4502
|
+
};
|
|
4503
|
+
type RevokeInvitationError = RevokeInvitationErrors[keyof RevokeInvitationErrors];
|
|
4504
|
+
type RevokeInvitationResponses = {
|
|
4505
|
+
/**
|
|
4506
|
+
* Revoked
|
|
4507
|
+
*/
|
|
4508
|
+
204: void;
|
|
4509
|
+
};
|
|
4510
|
+
type RevokeInvitationResponse = RevokeInvitationResponses[keyof RevokeInvitationResponses];
|
|
4511
|
+
type RemoveMemberData = {
|
|
4512
|
+
body?: never;
|
|
4513
|
+
path: {
|
|
4514
|
+
/**
|
|
4515
|
+
* Membership id (mem_...).
|
|
4516
|
+
*/
|
|
4517
|
+
id: string;
|
|
4518
|
+
};
|
|
4519
|
+
query?: never;
|
|
4520
|
+
url: '/v1/members/{id}';
|
|
4521
|
+
};
|
|
4522
|
+
type RemoveMemberErrors = {
|
|
4523
|
+
/**
|
|
4524
|
+
* Missing or invalid API key
|
|
4525
|
+
*/
|
|
4526
|
+
401: ErrorResponse;
|
|
4527
|
+
/**
|
|
4528
|
+
* The credential is an API key, its person is not an owner or admin, or an admin tried to remove an owner
|
|
4529
|
+
*/
|
|
4530
|
+
403: ErrorResponse;
|
|
4531
|
+
/**
|
|
4532
|
+
* Member not found
|
|
4533
|
+
*/
|
|
4534
|
+
404: ErrorResponse;
|
|
4535
|
+
/**
|
|
4536
|
+
* The last owner cannot be removed (last_owner)
|
|
4537
|
+
*/
|
|
4538
|
+
409: ErrorResponse;
|
|
4539
|
+
};
|
|
4540
|
+
type RemoveMemberError = RemoveMemberErrors[keyof RemoveMemberErrors];
|
|
4541
|
+
type RemoveMemberResponses = {
|
|
4542
|
+
/**
|
|
4543
|
+
* Removed
|
|
4544
|
+
*/
|
|
4545
|
+
204: void;
|
|
4546
|
+
};
|
|
4547
|
+
type RemoveMemberResponse = RemoveMemberResponses[keyof RemoveMemberResponses];
|
|
4548
|
+
type GetUsageData = {
|
|
4549
|
+
body?: never;
|
|
4550
|
+
path?: never;
|
|
4551
|
+
query?: never;
|
|
4552
|
+
url: '/v1/usage';
|
|
4553
|
+
};
|
|
4554
|
+
type GetUsageErrors = {
|
|
4555
|
+
/**
|
|
4556
|
+
* Missing or invalid API key
|
|
4557
|
+
*/
|
|
4558
|
+
401: ErrorResponse;
|
|
4559
|
+
};
|
|
4560
|
+
type GetUsageError = GetUsageErrors[keyof GetUsageErrors];
|
|
4561
|
+
type GetUsageResponses = {
|
|
4562
|
+
/**
|
|
4563
|
+
* The usage summary
|
|
4564
|
+
*/
|
|
4565
|
+
200: UsageSummary;
|
|
4566
|
+
};
|
|
4567
|
+
type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];
|
|
3774
4568
|
type DeleteAlertData = {
|
|
3775
4569
|
body?: never;
|
|
3776
4570
|
path: {
|
|
@@ -3836,7 +4630,7 @@ type UpdateAlertData = {
|
|
|
3836
4630
|
body: {
|
|
3837
4631
|
name?: string;
|
|
3838
4632
|
enabled?: boolean;
|
|
3839
|
-
mode?: 'instant' | 'daily';
|
|
4633
|
+
mode?: 'instant' | 'daily' | 'weekly';
|
|
3840
4634
|
/**
|
|
3841
4635
|
* Replaces the whole filter.
|
|
3842
4636
|
*/
|
|
@@ -3853,12 +4647,16 @@ type UpdateAlertData = {
|
|
|
3853
4647
|
* Only mentions scored at least this; unclassified ones never pass.
|
|
3854
4648
|
*/
|
|
3855
4649
|
minRelevance?: number;
|
|
4650
|
+
/**
|
|
4651
|
+
* Only mentions whose classifier confidence is at least this, 0 to 1. A mention without a confidence never passes.
|
|
4652
|
+
*/
|
|
4653
|
+
minConfidence?: number;
|
|
3856
4654
|
/**
|
|
3857
4655
|
* Only these sentiments.
|
|
3858
4656
|
*/
|
|
3859
4657
|
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
3860
4658
|
/**
|
|
3861
|
-
* At least one of these
|
|
4659
|
+
* At least one of these intent or topic tags.
|
|
3862
4660
|
*/
|
|
3863
4661
|
intents?: Array<string>;
|
|
3864
4662
|
/**
|
|
@@ -3877,12 +4675,24 @@ type UpdateAlertData = {
|
|
|
3877
4675
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
3878
4676
|
*/
|
|
3879
4677
|
linkHosts?: Array<string>;
|
|
4678
|
+
/**
|
|
4679
|
+
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
4680
|
+
*/
|
|
4681
|
+
languages?: Array<string>;
|
|
4682
|
+
/**
|
|
4683
|
+
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
4684
|
+
*/
|
|
4685
|
+
automated?: boolean;
|
|
3880
4686
|
};
|
|
3881
4687
|
schedule?: {
|
|
3882
4688
|
hour: number;
|
|
3883
4689
|
minute?: number;
|
|
3884
4690
|
timezone: string;
|
|
3885
4691
|
skipEmpty?: boolean;
|
|
4692
|
+
/**
|
|
4693
|
+
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
4694
|
+
*/
|
|
4695
|
+
weekday?: number;
|
|
3886
4696
|
} | null;
|
|
3887
4697
|
event?: string | null;
|
|
3888
4698
|
/**
|
|
@@ -3901,7 +4711,7 @@ type UpdateAlertData = {
|
|
|
3901
4711
|
};
|
|
3902
4712
|
type UpdateAlertErrors = {
|
|
3903
4713
|
/**
|
|
3904
|
-
* A daily rule without a schedule, or an unknown channel
|
|
4714
|
+
* A daily or weekly rule without a schedule (or a weekly one without a weekday), or an unknown channel
|
|
3905
4715
|
*/
|
|
3906
4716
|
400: ErrorResponse;
|
|
3907
4717
|
/**
|
|
@@ -3947,9 +4757,9 @@ type ListAlertsResponses = {
|
|
|
3947
4757
|
name: string;
|
|
3948
4758
|
enabled: boolean;
|
|
3949
4759
|
/**
|
|
3950
|
-
* instant: each matching mention as it happens. daily: one digest at the scheduled local time.
|
|
4760
|
+
* instant: each matching mention as it happens. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
|
|
3951
4761
|
*/
|
|
3952
|
-
mode: 'instant' | 'daily';
|
|
4762
|
+
mode: 'instant' | 'daily' | 'weekly';
|
|
3953
4763
|
filter: {
|
|
3954
4764
|
/**
|
|
3955
4765
|
* Only these keywords.
|
|
@@ -3963,12 +4773,16 @@ type ListAlertsResponses = {
|
|
|
3963
4773
|
* Only mentions scored at least this; unclassified ones never pass.
|
|
3964
4774
|
*/
|
|
3965
4775
|
minRelevance?: number;
|
|
4776
|
+
/**
|
|
4777
|
+
* Only mentions whose classifier confidence is at least this, 0 to 1. A mention without a confidence never passes.
|
|
4778
|
+
*/
|
|
4779
|
+
minConfidence?: number;
|
|
3966
4780
|
/**
|
|
3967
4781
|
* Only these sentiments.
|
|
3968
4782
|
*/
|
|
3969
4783
|
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
3970
4784
|
/**
|
|
3971
|
-
* At least one of these
|
|
4785
|
+
* At least one of these intent or topic tags.
|
|
3972
4786
|
*/
|
|
3973
4787
|
intents?: Array<string>;
|
|
3974
4788
|
/**
|
|
@@ -3987,15 +4801,27 @@ type ListAlertsResponses = {
|
|
|
3987
4801
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
3988
4802
|
*/
|
|
3989
4803
|
linkHosts?: Array<string>;
|
|
4804
|
+
/**
|
|
4805
|
+
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
4806
|
+
*/
|
|
4807
|
+
languages?: Array<string>;
|
|
4808
|
+
/**
|
|
4809
|
+
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
4810
|
+
*/
|
|
4811
|
+
automated?: boolean;
|
|
3990
4812
|
};
|
|
3991
4813
|
/**
|
|
3992
|
-
* Daily alerts only.
|
|
4814
|
+
* Daily and weekly alerts only.
|
|
3993
4815
|
*/
|
|
3994
4816
|
schedule: {
|
|
3995
4817
|
hour: number;
|
|
3996
4818
|
minute?: number;
|
|
3997
4819
|
timezone: string;
|
|
3998
4820
|
skipEmpty?: boolean;
|
|
4821
|
+
/**
|
|
4822
|
+
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
4823
|
+
*/
|
|
4824
|
+
weekday?: number;
|
|
3999
4825
|
} | null;
|
|
4000
4826
|
/**
|
|
4001
4827
|
* Event name carried in webhook payloads; the mode default unless you set one.
|
|
@@ -4022,7 +4848,7 @@ type ListAlertsResponses = {
|
|
|
4022
4848
|
*/
|
|
4023
4849
|
lastSentAt: string | null;
|
|
4024
4850
|
/**
|
|
4025
|
-
* Daily alerts: the next digest; null when disabled or instant.
|
|
4851
|
+
* Daily and weekly alerts: the next digest; null when disabled or instant.
|
|
4026
4852
|
*/
|
|
4027
4853
|
nextRunAt: string | null;
|
|
4028
4854
|
};
|
|
@@ -4038,7 +4864,7 @@ type CreateAlertData = {
|
|
|
4038
4864
|
body: {
|
|
4039
4865
|
name: string;
|
|
4040
4866
|
enabled?: boolean;
|
|
4041
|
-
mode?: 'instant' | 'daily';
|
|
4867
|
+
mode?: 'instant' | 'daily' | 'weekly';
|
|
4042
4868
|
filter?: {
|
|
4043
4869
|
/**
|
|
4044
4870
|
* Only these keywords.
|
|
@@ -4052,12 +4878,16 @@ type CreateAlertData = {
|
|
|
4052
4878
|
* Only mentions scored at least this; unclassified ones never pass.
|
|
4053
4879
|
*/
|
|
4054
4880
|
minRelevance?: number;
|
|
4881
|
+
/**
|
|
4882
|
+
* Only mentions whose classifier confidence is at least this, 0 to 1. A mention without a confidence never passes.
|
|
4883
|
+
*/
|
|
4884
|
+
minConfidence?: number;
|
|
4055
4885
|
/**
|
|
4056
4886
|
* Only these sentiments.
|
|
4057
4887
|
*/
|
|
4058
4888
|
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
4059
4889
|
/**
|
|
4060
|
-
* At least one of these
|
|
4890
|
+
* At least one of these intent or topic tags.
|
|
4061
4891
|
*/
|
|
4062
4892
|
intents?: Array<string>;
|
|
4063
4893
|
/**
|
|
@@ -4076,15 +4906,27 @@ type CreateAlertData = {
|
|
|
4076
4906
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
4077
4907
|
*/
|
|
4078
4908
|
linkHosts?: Array<string>;
|
|
4909
|
+
/**
|
|
4910
|
+
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
4911
|
+
*/
|
|
4912
|
+
languages?: Array<string>;
|
|
4913
|
+
/**
|
|
4914
|
+
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
4915
|
+
*/
|
|
4916
|
+
automated?: boolean;
|
|
4079
4917
|
};
|
|
4080
4918
|
/**
|
|
4081
|
-
* Required for daily alerts.
|
|
4919
|
+
* Required for daily and weekly alerts (weekly ones also need schedule.weekday).
|
|
4082
4920
|
*/
|
|
4083
4921
|
schedule?: {
|
|
4084
4922
|
hour: number;
|
|
4085
4923
|
minute?: number;
|
|
4086
4924
|
timezone: string;
|
|
4087
4925
|
skipEmpty?: boolean;
|
|
4926
|
+
/**
|
|
4927
|
+
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
4928
|
+
*/
|
|
4929
|
+
weekday?: number;
|
|
4088
4930
|
};
|
|
4089
4931
|
/**
|
|
4090
4932
|
* Custom event name for webhook payloads; null for the mode default.
|
|
@@ -4101,7 +4943,7 @@ type CreateAlertData = {
|
|
|
4101
4943
|
};
|
|
4102
4944
|
type CreateAlertErrors = {
|
|
4103
4945
|
/**
|
|
4104
|
-
* A daily rule without a schedule, or an unknown channel
|
|
4946
|
+
* A daily or weekly rule without a schedule (or a weekly one without a weekday), or an unknown channel
|
|
4105
4947
|
*/
|
|
4106
4948
|
400: ErrorResponse;
|
|
4107
4949
|
/**
|
|
@@ -4165,7 +5007,7 @@ type RunAlertDigestData = {
|
|
|
4165
5007
|
};
|
|
4166
5008
|
type RunAlertDigestErrors = {
|
|
4167
5009
|
/**
|
|
4168
|
-
* Only daily rules have a digest
|
|
5010
|
+
* Only daily and weekly rules have a digest
|
|
4169
5011
|
*/
|
|
4170
5012
|
400: ErrorResponse;
|
|
4171
5013
|
/**
|
|
@@ -4180,7 +5022,7 @@ type RunAlertDigestErrors = {
|
|
|
4180
5022
|
type RunAlertDigestError = RunAlertDigestErrors[keyof RunAlertDigestErrors];
|
|
4181
5023
|
type RunAlertDigestResponses = {
|
|
4182
5024
|
/**
|
|
4183
|
-
* The digest for the last
|
|
5025
|
+
* The digest for the rule's own period (the last day, or the last week) was sent now (the scheduled one still runs)
|
|
4184
5026
|
*/
|
|
4185
5027
|
200: {
|
|
4186
5028
|
/**
|
|
@@ -4361,13 +5203,13 @@ type GetAnalyticsSeriesData = {
|
|
|
4361
5203
|
*/
|
|
4362
5204
|
timezone?: string;
|
|
4363
5205
|
/**
|
|
4364
|
-
* Point granularity. Default: day up to 90 days, week beyond.
|
|
5206
|
+
* Point granularity: hour (windows of at most 14 days), day, week (Monday start) or month. Default: day up to 90 days, week beyond.
|
|
4365
5207
|
*/
|
|
4366
|
-
bucket?: 'day' | 'week';
|
|
5208
|
+
bucket?: 'hour' | 'day' | 'week' | 'month';
|
|
4367
5209
|
/**
|
|
4368
|
-
* Split into one series per platform
|
|
5210
|
+
* Split into one series per platform, per keyword (the top 20 by matched, the rest folded into "other") or per sentiment (positive, neutral, negative, unclassified). Omit for one total series.
|
|
4369
5211
|
*/
|
|
4370
|
-
by?: 'platform' | 'keyword';
|
|
5212
|
+
by?: 'platform' | 'keyword' | 'sentiment';
|
|
4371
5213
|
};
|
|
4372
5214
|
url: '/v1/analytics/series';
|
|
4373
5215
|
};
|
|
@@ -4422,9 +5264,9 @@ type GetAnalyticsBreakdownData = {
|
|
|
4422
5264
|
*/
|
|
4423
5265
|
timezone?: string;
|
|
4424
5266
|
/**
|
|
4425
|
-
* The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out).
|
|
5267
|
+
* The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one).
|
|
4426
5268
|
*/
|
|
4427
|
-
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person';
|
|
5269
|
+
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language';
|
|
4428
5270
|
};
|
|
4429
5271
|
url: '/v1/analytics/breakdown';
|
|
4430
5272
|
};
|
|
@@ -4808,7 +5650,7 @@ declare const listKeywords: <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
4808
5650
|
/**
|
|
4809
5651
|
* Track a keyword
|
|
4810
5652
|
*
|
|
4811
|
-
* Start tracking a word or phrase. Matching, classification and delivery begin on the next poll. A funded workspace tracks up to 500 keywords; each costs $5 per month, deducted daily from the balance.
|
|
5653
|
+
* Start tracking a word or phrase. Matching, classification and delivery begin on the next poll. A funded workspace tracks up to 500 keywords; each costs $5 per month, deducted daily from the balance. `matching` narrows what the term matches (required and excluded terms, excluded authors, case) before a mention is stored, so a rejected post is never billed; `context` is a sentence the classifier reads for this keyword only.
|
|
4812
5654
|
*/
|
|
4813
5655
|
declare const createKeyword: <ThrowOnError extends boolean = false>(options: Options<CreateKeywordData, ThrowOnError>) => RequestResult<CreateKeywordResponses, CreateKeywordErrors, ThrowOnError>;
|
|
4814
5656
|
/**
|
|
@@ -4824,9 +5666,21 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
|
|
|
4824
5666
|
/**
|
|
4825
5667
|
* Update a keyword
|
|
4826
5668
|
*
|
|
4827
|
-
* Mute or unmute it,
|
|
5669
|
+
* Mute or unmute it, reclassify it (`kind`), change the platforms it is tracked on, its classifier `context`, or its `matching` rules (each rule field optional; an empty list clears one). Rules apply to new mentions from the next poll; stored mentions are untouched.
|
|
4828
5670
|
*/
|
|
4829
5671
|
declare const updateKeyword: <ThrowOnError extends boolean = false>(options: Options<UpdateKeywordData, ThrowOnError>) => RequestResult<UpdateKeywordResponses, UpdateKeywordErrors, ThrowOnError>;
|
|
5672
|
+
/**
|
|
5673
|
+
* Get the workspace filters
|
|
5674
|
+
*
|
|
5675
|
+
* The noise rules applied to every keyword before a mention is stored: excluded terms and authors, excluded GitHub repositories, and the subreddits Reddit posts may (or may not) come from. A post they reject is never classified, delivered or billed. Keyword-level rules live on each keyword (`matching`); both apply.
|
|
5676
|
+
*/
|
|
5677
|
+
declare const getFilters: <ThrowOnError extends boolean = false>(options?: Options<GetFiltersData, ThrowOnError>) => RequestResult<GetFiltersResponses, GetFiltersErrors, ThrowOnError>;
|
|
5678
|
+
/**
|
|
5679
|
+
* Update the workspace filters
|
|
5680
|
+
*
|
|
5681
|
+
* Replace any of the lists; an omitted list is untouched and an empty one clears it. Entries are stored in canonical form (terms lowercased, authors as profile links or bare names, repositories as owner/name, subreddits without r/). Takes effect on new mentions within a minute; stored mentions are untouched.
|
|
5682
|
+
*/
|
|
5683
|
+
declare const updateFilters: <ThrowOnError extends boolean = false>(options: Options<UpdateFiltersData, ThrowOnError>) => RequestResult<UpdateFiltersResponses, UpdateFiltersErrors, ThrowOnError>;
|
|
4830
5684
|
/**
|
|
4831
5685
|
* Get a mention
|
|
4832
5686
|
*
|
|
@@ -4836,19 +5690,19 @@ declare const getMention: <ThrowOnError extends boolean = false>(options: Option
|
|
|
4836
5690
|
/**
|
|
4837
5691
|
* Update a mention
|
|
4838
5692
|
*
|
|
4839
|
-
* The one write on a mention. Set status to ignored or done to handle it (open puts it back), assign it to a workspace member, snooze it out of the feed,
|
|
5693
|
+
* The one write on a mention. Set status to ignored or done to handle it (open puts it back), assign it to a workspace member, snooze it out of the feed, leave an internal note, or correct the classifier: `relevant` true or false is your verdict (relevance becomes 100 or 0, and every list, filter, digest and report follows it), `sentiment` replaces the label; null withdraws a verdict and restores the classifier's value. Omitted fields are untouched. Delivery and billing never change.
|
|
4840
5694
|
*/
|
|
4841
5695
|
declare const updateMention: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionData, ThrowOnError>) => RequestResult<UpdateMentionResponses, UpdateMentionErrors, ThrowOnError>;
|
|
4842
5696
|
/**
|
|
4843
5697
|
* List mentions
|
|
4844
5698
|
*
|
|
4845
|
-
* Mentions matched to your keywords, filtered and paginated. Default order is newest match first; sort=priority ranks the last 30 days of matches by attention score. Page with nextCursor, passing the same filters and sort. A mention is one post matched to one keyword.
|
|
5699
|
+
* Mentions matched to your keywords, filtered and paginated. Default order is newest match first; sort=priority ranks the last 30 days of matches by attention score. Page with nextCursor, passing the same filters and sort. A mention is one post matched to one keyword. alertId applies an alert rule's filter on top of the others: the same mentions that rule would send.
|
|
4846
5700
|
*/
|
|
4847
5701
|
declare const searchMentions: <ThrowOnError extends boolean = false>(options?: Options<SearchMentionsData, ThrowOnError>) => RequestResult<SearchMentionsResponses, SearchMentionsErrors, ThrowOnError>;
|
|
4848
5702
|
/**
|
|
4849
5703
|
* Export mentions as CSV
|
|
4850
5704
|
*
|
|
4851
|
-
* The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), status, relevant, delivered, url, text (first 1,000 characters). Capped at 10,000 rows; the X-Mentions-Truncated header says when the cap cut the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
|
|
5705
|
+
* The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters). Capped at 10,000 rows; the X-Mentions-Truncated header says when the cap cut the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
|
|
4852
5706
|
*/
|
|
4853
5707
|
declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
|
|
4854
5708
|
/**
|
|
@@ -4948,7 +5802,7 @@ declare const listApiKeys: <ThrowOnError extends boolean = false>(options?: Opti
|
|
|
4948
5802
|
/**
|
|
4949
5803
|
* Create an API key
|
|
4950
5804
|
*
|
|
4951
|
-
* Mint a key for this workspace. The key itself is returned once; only its hash is stored.
|
|
5805
|
+
* Mint a key for this workspace. The key itself is returned once; only its hash is stored. `expiresAt` makes it stop working at an instant (a key for a contractor or a one-off script); it stays listed until revoked.
|
|
4952
5806
|
*/
|
|
4953
5807
|
declare const createApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>) => RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
|
|
4954
5808
|
/**
|
|
@@ -4957,6 +5811,48 @@ declare const createApiKey: <ThrowOnError extends boolean = false>(options: Opti
|
|
|
4957
5811
|
* Takes effect at once on the API and within a few minutes on cached verifications.
|
|
4958
5812
|
*/
|
|
4959
5813
|
declare const revokeApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeApiKeyData, ThrowOnError>) => RequestResult<RevokeApiKeyResponses, RevokeApiKeyErrors, ThrowOnError>;
|
|
5814
|
+
/**
|
|
5815
|
+
* Introspect the credential
|
|
5816
|
+
*
|
|
5817
|
+
* The workspace this credential acts on, how the request authenticated (an API key, an OAuth access token from an MCP sign-in, or the dashboard session), whether it may write, and for a key its id and expiry. Run it first: a read key answers 403 read_only_key on every write, and a wrong workspace is the classic scripting mistake.
|
|
5818
|
+
*/
|
|
5819
|
+
declare const whoami: <ThrowOnError extends boolean = false>(options?: Options<WhoamiData, ThrowOnError>) => RequestResult<WhoamiResponses, WhoamiErrors, ThrowOnError>;
|
|
5820
|
+
/**
|
|
5821
|
+
* List members
|
|
5822
|
+
*
|
|
5823
|
+
* Everyone in the workspace, owners first. `userId` is what a mention's assigneeId and a person's ownerId take.
|
|
5824
|
+
*/
|
|
5825
|
+
declare const listMembers: <ThrowOnError extends boolean = false>(options?: Options<ListMembersData, ThrowOnError>) => RequestResult<ListMembersResponses, ListMembersErrors, ThrowOnError>;
|
|
5826
|
+
/**
|
|
5827
|
+
* List pending invitations
|
|
5828
|
+
*
|
|
5829
|
+
* Invitations sent and not yet accepted, declined or expired. An accepted one appears in GET /v1/members instead.
|
|
5830
|
+
*/
|
|
5831
|
+
declare const listInvitations: <ThrowOnError extends boolean = false>(options?: Options<ListInvitationsData, ThrowOnError>) => RequestResult<ListInvitationsResponses, ListInvitationsErrors, ThrowOnError>;
|
|
5832
|
+
/**
|
|
5833
|
+
* Invite a member
|
|
5834
|
+
*
|
|
5835
|
+
* Send an email invitation to join the workspace as admin or member; it expires after 48 hours. Idempotent: an address that already holds an open invitation gets it back with 200 and no second email. An address that is already a member is a 409 already_member. Team changes need a signed-in owner or admin (an OAuth token from an MCP sign-in, or the dashboard session): an API key answers 403.
|
|
5836
|
+
*/
|
|
5837
|
+
declare const createInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateInvitationData, ThrowOnError>) => RequestResult<CreateInvitationResponses, CreateInvitationErrors, ThrowOnError>;
|
|
5838
|
+
/**
|
|
5839
|
+
* Revoke an invitation
|
|
5840
|
+
*
|
|
5841
|
+
* The link in the email stops working at once. Needs a signed-in owner or admin; an API key answers 403.
|
|
5842
|
+
*/
|
|
5843
|
+
declare const revokeInvitation: <ThrowOnError extends boolean = false>(options: Options<RevokeInvitationData, ThrowOnError>) => RequestResult<RevokeInvitationResponses, RevokeInvitationErrors, ThrowOnError>;
|
|
5844
|
+
/**
|
|
5845
|
+
* Remove a member
|
|
5846
|
+
*
|
|
5847
|
+
* The person loses the workspace within a minute (their dashboard session on the next request, an OAuth token when its short cache lapses). Their mentions, notes and outreach stay. Needs a signed-in owner or admin; only an owner removes another owner, and the last owner cannot be removed (409 last_owner).
|
|
5848
|
+
*/
|
|
5849
|
+
declare const removeMember: <ThrowOnError extends boolean = false>(options: Options<RemoveMemberData, ThrowOnError>) => RequestResult<RemoveMemberResponses, RemoveMemberErrors, ThrowOnError>;
|
|
5850
|
+
/**
|
|
5851
|
+
* Get usage and balance
|
|
5852
|
+
*
|
|
5853
|
+
* The prepaid balance (ledger, pending mention charges, and the effective balance the stop rule reads), the daily burn and the days it buys, the keywords the wallet runs and pauses, the matches recorded today and over 30 days, and whether tracking is stopped or the balance is low. Every matched mention bills ($0.008), relevant or not; every active keyword bills $5 a month, charged daily.
|
|
5854
|
+
*/
|
|
5855
|
+
declare const getUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) => RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError>;
|
|
4960
5856
|
/**
|
|
4961
5857
|
* Delete an alert
|
|
4962
5858
|
*/
|
|
@@ -4975,6 +5871,8 @@ declare const updateAlert: <ThrowOnError extends boolean = false>(options: Optio
|
|
|
4975
5871
|
declare const listAlerts: <ThrowOnError extends boolean = false>(options?: Options<ListAlertsData, ThrowOnError>) => RequestResult<ListAlertsResponses, ListAlertsErrors, ThrowOnError>;
|
|
4976
5872
|
/**
|
|
4977
5873
|
* Create an alert
|
|
5874
|
+
*
|
|
5875
|
+
* A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday).
|
|
4978
5876
|
*/
|
|
4979
5877
|
declare const createAlert: <ThrowOnError extends boolean = false>(options: Options<CreateAlertData, ThrowOnError>) => RequestResult<CreateAlertResponses, CreateAlertErrors, ThrowOnError>;
|
|
4980
5878
|
/**
|
|
@@ -5058,6 +5956,7 @@ type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boo
|
|
|
5058
5956
|
declare const sdk_createAlert: typeof createAlert;
|
|
5059
5957
|
declare const sdk_createApiKey: typeof createApiKey;
|
|
5060
5958
|
declare const sdk_createChannel: typeof createChannel;
|
|
5959
|
+
declare const sdk_createInvitation: typeof createInvitation;
|
|
5061
5960
|
declare const sdk_createKeyword: typeof createKeyword;
|
|
5062
5961
|
declare const sdk_createSegment: typeof createSegment;
|
|
5063
5962
|
declare const sdk_deleteAlert: typeof deleteAlert;
|
|
@@ -5073,24 +5972,30 @@ declare const sdk_getAnalyticsSeries: typeof getAnalyticsSeries;
|
|
|
5073
5972
|
declare const sdk_getAnalyticsSummary: typeof getAnalyticsSummary;
|
|
5074
5973
|
declare const sdk_getChannel: typeof getChannel;
|
|
5075
5974
|
declare const sdk_getCompany: typeof getCompany;
|
|
5975
|
+
declare const sdk_getFilters: typeof getFilters;
|
|
5076
5976
|
declare const sdk_getHealth: typeof getHealth;
|
|
5077
5977
|
declare const sdk_getKeyword: typeof getKeyword;
|
|
5078
5978
|
declare const sdk_getMention: typeof getMention;
|
|
5079
5979
|
declare const sdk_getPerson: typeof getPerson;
|
|
5080
5980
|
declare const sdk_getSegment: typeof getSegment;
|
|
5081
5981
|
declare const sdk_getShareOfVoice: typeof getShareOfVoice;
|
|
5982
|
+
declare const sdk_getUsage: typeof getUsage;
|
|
5082
5983
|
declare const sdk_listAlerts: typeof listAlerts;
|
|
5083
5984
|
declare const sdk_listApiKeys: typeof listApiKeys;
|
|
5084
5985
|
declare const sdk_listChannelDeliveries: typeof listChannelDeliveries;
|
|
5085
5986
|
declare const sdk_listChannels: typeof listChannels;
|
|
5987
|
+
declare const sdk_listInvitations: typeof listInvitations;
|
|
5086
5988
|
declare const sdk_listKeywords: typeof listKeywords;
|
|
5989
|
+
declare const sdk_listMembers: typeof listMembers;
|
|
5087
5990
|
declare const sdk_listPeople: typeof listPeople;
|
|
5088
5991
|
declare const sdk_listPersonActivities: typeof listPersonActivities;
|
|
5089
5992
|
declare const sdk_listSegments: typeof listSegments;
|
|
5090
5993
|
declare const sdk_logPersonActivity: typeof logPersonActivity;
|
|
5091
5994
|
declare const sdk_mergePeople: typeof mergePeople;
|
|
5092
5995
|
declare const sdk_muteAlertAuthors: typeof muteAlertAuthors;
|
|
5996
|
+
declare const sdk_removeMember: typeof removeMember;
|
|
5093
5997
|
declare const sdk_revokeApiKey: typeof revokeApiKey;
|
|
5998
|
+
declare const sdk_revokeInvitation: typeof revokeInvitation;
|
|
5094
5999
|
declare const sdk_rotateWebhookSecret: typeof rotateWebhookSecret;
|
|
5095
6000
|
declare const sdk_runAlertDigest: typeof runAlertDigest;
|
|
5096
6001
|
declare const sdk_searchMentions: typeof searchMentions;
|
|
@@ -5101,12 +6006,14 @@ declare const sdk_unmuteAlertAuthors: typeof unmuteAlertAuthors;
|
|
|
5101
6006
|
declare const sdk_updateAlert: typeof updateAlert;
|
|
5102
6007
|
declare const sdk_updateChannel: typeof updateChannel;
|
|
5103
6008
|
declare const sdk_updateCompany: typeof updateCompany;
|
|
6009
|
+
declare const sdk_updateFilters: typeof updateFilters;
|
|
5104
6010
|
declare const sdk_updateKeyword: typeof updateKeyword;
|
|
5105
6011
|
declare const sdk_updateMention: typeof updateMention;
|
|
5106
6012
|
declare const sdk_updatePerson: typeof updatePerson;
|
|
5107
6013
|
declare const sdk_updateSegment: typeof updateSegment;
|
|
6014
|
+
declare const sdk_whoami: typeof whoami;
|
|
5108
6015
|
declare namespace sdk {
|
|
5109
|
-
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getHealth as getHealth, sdk_getKeyword as getKeyword, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listKeywords as listKeywords, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_revokeApiKey as revokeApiKey, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment };
|
|
6016
|
+
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFilters as getFilters, sdk_getHealth as getHealth, sdk_getKeyword as getKeyword, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listInvitations as listInvitations, sdk_listKeywords as listKeywords, sdk_listMembers as listMembers, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFilters as updateFilters, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_whoami as whoami };
|
|
5110
6017
|
}
|
|
5111
6018
|
|
|
5112
6019
|
/**
|
|
@@ -5134,4 +6041,4 @@ type Mentio = typeof sdk & {
|
|
|
5134
6041
|
};
|
|
5135
6042
|
declare function createMentio(options: MentioOptions): Mentio;
|
|
5136
6043
|
|
|
5137
|
-
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type Channel, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type Keyword, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Mentio, type MentioOptions, type Mention, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type Options, type Person, type PersonActivity, type RequestResult, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type WebhookChannel, createAlert, createApiKey, createChannel, createClient, createConfig, createKeyword, createMentio, createSegment, deleteAlert, deleteChannel, deleteKeyword, deletePersonActivity, deleteSegment, exportMentionsCsv, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getHealth, getKeyword, getMention, getPerson, getSegment, getShareOfVoice, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listKeywords, listPeople, listPersonActivities, listSegments, logPersonActivity, mergePeople, muteAlertAuthors, revokeApiKey, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateKeyword, updateMention, updatePerson, updateSegment };
|
|
6044
|
+
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type Channel, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type Invitation, type Keyword, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UsageSummary, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createInvitation, createKeyword, createMentio, createSegment, deleteAlert, deleteChannel, deleteKeyword, deletePersonActivity, deleteSegment, exportMentionsCsv, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getHealth, getKeyword, getMention, getPerson, getSegment, getShareOfVoice, getUsage, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listInvitations, listKeywords, listMembers, listPeople, listPersonActivities, listSegments, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateKeyword, updateMention, updatePerson, updateSegment, whoami };
|