@mentio-dev/sdk 0.11.3 → 0.12.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 +700 -91
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -351,6 +351,20 @@ type GroupRef = {
|
|
|
351
351
|
*/
|
|
352
352
|
isDefault: boolean;
|
|
353
353
|
};
|
|
354
|
+
type KeywordFeed = {
|
|
355
|
+
/**
|
|
356
|
+
* The feed itself (after redirects): what is polled.
|
|
357
|
+
*/
|
|
358
|
+
url: string;
|
|
359
|
+
/**
|
|
360
|
+
* The feed's own title, when it has one.
|
|
361
|
+
*/
|
|
362
|
+
title: string | null;
|
|
363
|
+
/**
|
|
364
|
+
* When this keyword started reading the feed: nothing published before it is a live mention.
|
|
365
|
+
*/
|
|
366
|
+
connectedAt: string;
|
|
367
|
+
};
|
|
354
368
|
type ReviewSource = {
|
|
355
369
|
/**
|
|
356
370
|
* appstore (Apple App Store), googleplay (Google Play), trustpilot (a company's Trustpilot page) or googlemaps (a place's Google reviews).
|
|
@@ -405,7 +419,7 @@ type Keyword = {
|
|
|
405
419
|
*/
|
|
406
420
|
cap: {
|
|
407
421
|
/**
|
|
408
|
-
*
|
|
422
|
+
* Charged items allowed per calendar month (UTC): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
409
423
|
*/
|
|
410
424
|
mentions: number;
|
|
411
425
|
/**
|
|
@@ -417,11 +431,28 @@ type Keyword = {
|
|
|
417
431
|
*/
|
|
418
432
|
own: number | null;
|
|
419
433
|
} | null;
|
|
434
|
+
/**
|
|
435
|
+
* Comments under this keyword's mentions: when enabled, the comments of every mention scored relevant are read from 30 minutes after the post, on a schedule per platform (for a day on Reddit, Hacker News and Bluesky, a week on GitHub, Stack Overflow and DEV, a month on YouTube) (new comments only, at most maxPerPost a thread, comments of fewer than three words dropped), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments.
|
|
436
|
+
*/
|
|
437
|
+
comments: {
|
|
438
|
+
/**
|
|
439
|
+
* Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
|
|
440
|
+
*/
|
|
441
|
+
enabled: boolean;
|
|
442
|
+
/**
|
|
443
|
+
* The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
|
|
444
|
+
*/
|
|
445
|
+
maxPerPost: number;
|
|
446
|
+
};
|
|
420
447
|
group: GroupRef;
|
|
421
448
|
/**
|
|
422
449
|
* Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
|
|
423
450
|
*/
|
|
424
451
|
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
452
|
+
/**
|
|
453
|
+
* RSS and Atom feeds this keyword reads; empty for none.
|
|
454
|
+
*/
|
|
455
|
+
feeds: Array<KeywordFeed>;
|
|
425
456
|
/**
|
|
426
457
|
* Where this keyword collects reviews from (App Store and Google Play apps, Trustpilot pages, Google Maps places); empty for none.
|
|
427
458
|
*/
|
|
@@ -458,6 +489,36 @@ type Keyword = {
|
|
|
458
489
|
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
459
490
|
*/
|
|
460
491
|
exactPhrase: boolean;
|
|
492
|
+
/**
|
|
493
|
+
* Reddit only, for this keyword alone; the workspace filters' own subreddit lists (GET /v1/filters) still apply to every keyword, and a post must pass both.
|
|
494
|
+
*/
|
|
495
|
+
subreddits: {
|
|
496
|
+
/**
|
|
497
|
+
* When non-empty, this keyword takes Reddit posts from these subreddits ONLY and `excluded` is ignored. r/name or name, stored bare and lowercase.
|
|
498
|
+
*/
|
|
499
|
+
only: Array<string>;
|
|
500
|
+
/**
|
|
501
|
+
* Reddit posts from these subreddits are dropped for this keyword. r/name or name.
|
|
502
|
+
*/
|
|
503
|
+
excluded: Array<string>;
|
|
504
|
+
};
|
|
505
|
+
/**
|
|
506
|
+
* GitHub only: which repository events naming this keyword become mentions. An event outside the rule is dropped before it is stored, so it is never billed.
|
|
507
|
+
*/
|
|
508
|
+
repositories: {
|
|
509
|
+
/**
|
|
510
|
+
* The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
|
|
511
|
+
*/
|
|
512
|
+
events: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
513
|
+
/**
|
|
514
|
+
* Only repositories with at least this many stars; null for no minimum.
|
|
515
|
+
*/
|
|
516
|
+
minStars: number | null;
|
|
517
|
+
/**
|
|
518
|
+
* Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
|
|
519
|
+
*/
|
|
520
|
+
minWeeklyStars: number | null;
|
|
521
|
+
};
|
|
461
522
|
};
|
|
462
523
|
/**
|
|
463
524
|
* Computed over this workspace's matches.
|
|
@@ -476,7 +537,7 @@ type Keyword = {
|
|
|
476
537
|
*/
|
|
477
538
|
last7d: number;
|
|
478
539
|
/**
|
|
479
|
-
* Matches recorded this calendar month (UTC), the count a cap compares against.
|
|
540
|
+
* Matches recorded this calendar month (UTC), plus the thread comments delivered under this keyword's mentions: the count a cap compares against.
|
|
480
541
|
*/
|
|
481
542
|
thisMonth: number;
|
|
482
543
|
/**
|
|
@@ -538,7 +599,15 @@ type Keyword = {
|
|
|
538
599
|
*/
|
|
539
600
|
mentionCents: number;
|
|
540
601
|
/**
|
|
541
|
-
*
|
|
602
|
+
* Comments billed this month under this keyword: comments delivered in its threads and comments it matched, each once per workspace.
|
|
603
|
+
*/
|
|
604
|
+
billableComments: number;
|
|
605
|
+
/**
|
|
606
|
+
* Those comments at $0.008 each, rounded once on the total.
|
|
607
|
+
*/
|
|
608
|
+
commentCents: number;
|
|
609
|
+
/**
|
|
610
|
+
* keywordCents plus mentionCents plus commentCents: what this keyword has cost this month, in USD cents.
|
|
542
611
|
*/
|
|
543
612
|
totalCents: number;
|
|
544
613
|
};
|
|
@@ -548,9 +617,9 @@ type Keyword = {
|
|
|
548
617
|
*/
|
|
549
618
|
polling: Array<{
|
|
550
619
|
/**
|
|
551
|
-
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).
|
|
620
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
552
621
|
*/
|
|
553
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
622
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
554
623
|
/**
|
|
555
624
|
* Newest poll of this platform for the term; null until the first one.
|
|
556
625
|
*/
|
|
@@ -649,16 +718,59 @@ type KeywordSuggestion = {
|
|
|
649
718
|
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
650
719
|
*/
|
|
651
720
|
exactPhrase?: boolean;
|
|
721
|
+
/**
|
|
722
|
+
* GitHub only: each field is replaced when sent, kept when omitted; null clears a minimum.
|
|
723
|
+
*/
|
|
724
|
+
repositories?: {
|
|
725
|
+
/**
|
|
726
|
+
* The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
|
|
727
|
+
*/
|
|
728
|
+
events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
729
|
+
/**
|
|
730
|
+
* Only repositories with at least this many stars; null for no minimum.
|
|
731
|
+
*/
|
|
732
|
+
minStars?: number | null;
|
|
733
|
+
/**
|
|
734
|
+
* Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
|
|
735
|
+
*/
|
|
736
|
+
minWeeklyStars?: number | null;
|
|
737
|
+
};
|
|
738
|
+
/**
|
|
739
|
+
* Reddit only, for this keyword alone: each list is replaced when sent, kept when omitted.
|
|
740
|
+
*/
|
|
741
|
+
subreddits?: {
|
|
742
|
+
/**
|
|
743
|
+
* Replaces the keyword's allowlist; [] clears it.
|
|
744
|
+
*/
|
|
745
|
+
only?: Array<string>;
|
|
746
|
+
/**
|
|
747
|
+
* Replaces the keyword's deny list; [] clears it.
|
|
748
|
+
*/
|
|
749
|
+
excluded?: Array<string>;
|
|
750
|
+
};
|
|
652
751
|
};
|
|
653
752
|
/**
|
|
654
753
|
* Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it.
|
|
655
754
|
*/
|
|
656
755
|
cap?: {
|
|
657
756
|
/**
|
|
658
|
-
*
|
|
757
|
+
* Charged items allowed per calendar month (UTC): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
659
758
|
*/
|
|
660
759
|
mentions: number;
|
|
661
760
|
} | null;
|
|
761
|
+
/**
|
|
762
|
+
* Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
|
|
763
|
+
*/
|
|
764
|
+
comments?: {
|
|
765
|
+
/**
|
|
766
|
+
* Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
|
|
767
|
+
*/
|
|
768
|
+
enabled?: boolean;
|
|
769
|
+
/**
|
|
770
|
+
* The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
|
|
771
|
+
*/
|
|
772
|
+
maxPerPost?: number;
|
|
773
|
+
};
|
|
662
774
|
/**
|
|
663
775
|
* Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
|
|
664
776
|
*/
|
|
@@ -688,6 +800,15 @@ type KeywordSuggestion = {
|
|
|
688
800
|
*/
|
|
689
801
|
language?: string;
|
|
690
802
|
}>;
|
|
803
|
+
/**
|
|
804
|
+
* Replaces the feeds this keyword reads; [] disconnects them all (their mentions stay). A feed added here is checked now and brings its newest 10 matching items of the last 30 days; one already listed keeps its place.
|
|
805
|
+
*/
|
|
806
|
+
feeds?: Array<{
|
|
807
|
+
/**
|
|
808
|
+
* A feed's address (https://forum.example.com/posts.rss), or a page's (https://forum.example.com): the feed the page advertises is used.
|
|
809
|
+
*/
|
|
810
|
+
url: string;
|
|
811
|
+
}>;
|
|
691
812
|
};
|
|
692
813
|
/**
|
|
693
814
|
* What the change would have done over the window, measured with the matcher's own rules. Null for a context, which changes scores, not matches.
|
|
@@ -813,9 +934,9 @@ type KeywordHealth = {
|
|
|
813
934
|
*/
|
|
814
935
|
byPlatform: Array<{
|
|
815
936
|
/**
|
|
816
|
-
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).
|
|
937
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
817
938
|
*/
|
|
818
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
939
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
819
940
|
/**
|
|
820
941
|
* Matches on this platform in the window.
|
|
821
942
|
*/
|
|
@@ -871,7 +992,15 @@ type KeywordHealth = {
|
|
|
871
992
|
*/
|
|
872
993
|
mentionCents: number;
|
|
873
994
|
/**
|
|
874
|
-
*
|
|
995
|
+
* Comments billed in the window under the keyword (0074).
|
|
996
|
+
*/
|
|
997
|
+
billableComments: number;
|
|
998
|
+
/**
|
|
999
|
+
* Those comments at the comment rate.
|
|
1000
|
+
*/
|
|
1001
|
+
commentCents: number;
|
|
1002
|
+
/**
|
|
1003
|
+
* keywordCents, mentionCents and commentCents: its row in GET /v1/usage/breakdown for the same range.
|
|
875
1004
|
*/
|
|
876
1005
|
totalCents: number;
|
|
877
1006
|
};
|
|
@@ -1028,9 +1157,13 @@ type Mention = {
|
|
|
1028
1157
|
};
|
|
1029
1158
|
post: {
|
|
1030
1159
|
/**
|
|
1031
|
-
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).
|
|
1160
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
1032
1161
|
*/
|
|
1033
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
1162
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1163
|
+
/**
|
|
1164
|
+
* post: a top-level post. comment: an item that answers a post or another comment (a Reddit or Hacker News comment, an X or Bluesky reply, a Stack Overflow answer, a YouTube comment). repository: an event about a GitHub repository naming the keyword (see post.repository).
|
|
1165
|
+
*/
|
|
1166
|
+
kind: 'post' | 'comment' | 'repository';
|
|
1034
1167
|
/**
|
|
1035
1168
|
* Permalink of the post.
|
|
1036
1169
|
*/
|
|
@@ -1047,6 +1180,35 @@ type Mention = {
|
|
|
1047
1180
|
* A preview image of the post, when the platform sent one with it: a YouTube thumbnail, a DEV cover, a news article's sharing image, a Bluesky link card or image. Null otherwise.
|
|
1048
1181
|
*/
|
|
1049
1182
|
imageUrl: string | null;
|
|
1183
|
+
/**
|
|
1184
|
+
* The subreddit a Reddit post was written in, without the r/ (SaaS). Null on every other platform.
|
|
1185
|
+
*/
|
|
1186
|
+
subreddit: string | null;
|
|
1187
|
+
/**
|
|
1188
|
+
* A Reddit post's flair, when its subreddit uses them (Question, Show and Tell). Null otherwise.
|
|
1189
|
+
*/
|
|
1190
|
+
flair: string | null;
|
|
1191
|
+
/**
|
|
1192
|
+
* A GitHub repository event's facts, on a mention whose kind is repository; null on every other mention. The sentence is post.title.
|
|
1193
|
+
*/
|
|
1194
|
+
repository: {
|
|
1195
|
+
/**
|
|
1196
|
+
* The repository, owner/name.
|
|
1197
|
+
*/
|
|
1198
|
+
name: string;
|
|
1199
|
+
/**
|
|
1200
|
+
* What happened. new: it was created. traction: under 30 days old, it reached 10 stars. stars: it passed a star milestone. growth: it gained stars fast in a week. top: one of the most starred repositories naming the keyword, brought by a new keyword's look-back.
|
|
1201
|
+
*/
|
|
1202
|
+
event: 'new' | 'traction' | 'stars' | 'growth' | 'top';
|
|
1203
|
+
/**
|
|
1204
|
+
* Its stars when the event was found.
|
|
1205
|
+
*/
|
|
1206
|
+
stars: number;
|
|
1207
|
+
/**
|
|
1208
|
+
* Stars gained in the 7 days before the event; null when that week is not known yet.
|
|
1209
|
+
*/
|
|
1210
|
+
weeklyStars: number | null;
|
|
1211
|
+
} | null;
|
|
1050
1212
|
/**
|
|
1051
1213
|
* Links the post carries, in the order written, at most 20. Empty for a post with none, and for posts ingested before September 2026.
|
|
1052
1214
|
*/
|
|
@@ -1067,7 +1229,7 @@ type Mention = {
|
|
|
1067
1229
|
bookmarks: number | null;
|
|
1068
1230
|
} | null;
|
|
1069
1231
|
/**
|
|
1070
|
-
* The post this one
|
|
1232
|
+
* The post or comment this one answers; null for top-level posts.
|
|
1071
1233
|
*/
|
|
1072
1234
|
replyTo: {
|
|
1073
1235
|
/**
|
|
@@ -1084,6 +1246,10 @@ type Mention = {
|
|
|
1084
1246
|
text: string | null;
|
|
1085
1247
|
} | null;
|
|
1086
1248
|
};
|
|
1249
|
+
/**
|
|
1250
|
+
* For a comment whose parent post or comment is itself one of your mentions: that mention's id (mm_...). Null otherwise.
|
|
1251
|
+
*/
|
|
1252
|
+
parentMentionId: string | null;
|
|
1087
1253
|
/**
|
|
1088
1254
|
* Who posted it; null when the platform gave no author at all.
|
|
1089
1255
|
*/
|
|
@@ -1260,11 +1426,112 @@ type Mention = {
|
|
|
1260
1426
|
*/
|
|
1261
1427
|
note: string | null;
|
|
1262
1428
|
};
|
|
1429
|
+
/**
|
|
1430
|
+
* Set on a cross-post: the id of the mention this one copies (the same author posting the same text again for the same keyword within three days, like one announcement pasted into five subreddits). A copy is billed like any mention but is listed only under its original and never alerted on its own. null for an original.
|
|
1431
|
+
*/
|
|
1432
|
+
duplicateOf: string | null;
|
|
1433
|
+
/**
|
|
1434
|
+
* The cross-posts filed under this mention, oldest first: where else its author posted it. Empty when there are none, and on a copy.
|
|
1435
|
+
*/
|
|
1436
|
+
duplicates: Array<{
|
|
1437
|
+
/**
|
|
1438
|
+
* The copy's mention id (mm_...).
|
|
1439
|
+
*/
|
|
1440
|
+
id: string;
|
|
1441
|
+
/**
|
|
1442
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
1443
|
+
*/
|
|
1444
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1445
|
+
/**
|
|
1446
|
+
* Link to the copy.
|
|
1447
|
+
*/
|
|
1448
|
+
url: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* When the copy was published.
|
|
1451
|
+
*/
|
|
1452
|
+
publishedAt: string;
|
|
1453
|
+
}>;
|
|
1454
|
+
/**
|
|
1455
|
+
* Computed counts.
|
|
1456
|
+
*/
|
|
1457
|
+
stats: {
|
|
1458
|
+
/**
|
|
1459
|
+
* Comments of this post delivered to you (GET /v1/mentions/{id}/comments); 0 until its thread is read, and for keywords without comments.
|
|
1460
|
+
*/
|
|
1461
|
+
comments: number;
|
|
1462
|
+
};
|
|
1263
1463
|
/**
|
|
1264
1464
|
* When the match was recorded; the default feed order.
|
|
1265
1465
|
*/
|
|
1266
1466
|
createdAt: string;
|
|
1267
1467
|
};
|
|
1468
|
+
type MentionComment = {
|
|
1469
|
+
/**
|
|
1470
|
+
* Comment id (men_...): the item itself, the same for every workspace it reaches.
|
|
1471
|
+
*/
|
|
1472
|
+
id: string;
|
|
1473
|
+
/**
|
|
1474
|
+
* Permalink of the comment.
|
|
1475
|
+
*/
|
|
1476
|
+
url: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* The comment, truncated to 8 KB at ingest.
|
|
1479
|
+
*/
|
|
1480
|
+
text: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* When the comment was written.
|
|
1483
|
+
*/
|
|
1484
|
+
publishedAt: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Who wrote it; null when the platform gave no author (a deleted account).
|
|
1487
|
+
*/
|
|
1488
|
+
author: {
|
|
1489
|
+
/**
|
|
1490
|
+
* As the platform names them.
|
|
1491
|
+
*/
|
|
1492
|
+
name: string | null;
|
|
1493
|
+
/**
|
|
1494
|
+
* Their profile.
|
|
1495
|
+
*/
|
|
1496
|
+
url: string | null;
|
|
1497
|
+
/**
|
|
1498
|
+
* Their profile picture, when the platform sends one.
|
|
1499
|
+
*/
|
|
1500
|
+
avatarUrl: string | null;
|
|
1501
|
+
} | null;
|
|
1502
|
+
/**
|
|
1503
|
+
* The comment this one answers, when it is a reply inside the thread; null for a comment on the post itself.
|
|
1504
|
+
*/
|
|
1505
|
+
parentCommentId: string | null;
|
|
1506
|
+
/**
|
|
1507
|
+
* Engagement counts as the platform reported them when the post was ingested, usually minutes after it was written; a count the platform does not have is null. Null as a whole for platforms that report none and for posts ingested before September 2026. X carries all six.
|
|
1508
|
+
*/
|
|
1509
|
+
engagement: {
|
|
1510
|
+
likes: number | null;
|
|
1511
|
+
reposts: number | null;
|
|
1512
|
+
replies: number | null;
|
|
1513
|
+
quotes: number | null;
|
|
1514
|
+
views: number | null;
|
|
1515
|
+
bookmarks: number | null;
|
|
1516
|
+
} | null;
|
|
1517
|
+
/**
|
|
1518
|
+
* A light read of the comment (sentiment and intent tags); null until it is scored, usually minutes after the thread arrives.
|
|
1519
|
+
*/
|
|
1520
|
+
classification: {
|
|
1521
|
+
/**
|
|
1522
|
+
* Classifier sentiment.
|
|
1523
|
+
*/
|
|
1524
|
+
sentiment: 'positive' | 'neutral' | 'negative';
|
|
1525
|
+
/**
|
|
1526
|
+
* Intent and topic tags, the same vocabulary as a mention's.
|
|
1527
|
+
*/
|
|
1528
|
+
intents: Array<string>;
|
|
1529
|
+
} | null;
|
|
1530
|
+
/**
|
|
1531
|
+
* When this comment itself names one of your keywords, its mention (mm_...), with the full verdict. Null otherwise.
|
|
1532
|
+
*/
|
|
1533
|
+
mentionId: string | null;
|
|
1534
|
+
};
|
|
1268
1535
|
type Person = {
|
|
1269
1536
|
/**
|
|
1270
1537
|
* Person id (aut_...): the canonical account. An account merged into someone resolves to that person.
|
|
@@ -1273,7 +1540,7 @@ type Person = {
|
|
|
1273
1540
|
/**
|
|
1274
1541
|
* Platform of the canonical account; `accounts` lists every account.
|
|
1275
1542
|
*/
|
|
1276
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
1543
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1277
1544
|
/**
|
|
1278
1545
|
* Display name as of their newest post; null when the platform has none.
|
|
1279
1546
|
*/
|
|
@@ -1296,9 +1563,9 @@ type Person = {
|
|
|
1296
1563
|
*/
|
|
1297
1564
|
id: string;
|
|
1298
1565
|
/**
|
|
1299
|
-
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).
|
|
1566
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
1300
1567
|
*/
|
|
1301
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
1568
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1302
1569
|
/**
|
|
1303
1570
|
* Display name as the platform reports it.
|
|
1304
1571
|
*/
|
|
@@ -1454,7 +1721,7 @@ type Segment = {
|
|
|
1454
1721
|
/**
|
|
1455
1722
|
* People with an account on any of these platforms.
|
|
1456
1723
|
*/
|
|
1457
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
1724
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1458
1725
|
/**
|
|
1459
1726
|
* People carrying any of these tags.
|
|
1460
1727
|
*/
|
|
@@ -1490,7 +1757,7 @@ type Segment = {
|
|
|
1490
1757
|
/**
|
|
1491
1758
|
* Nobody with an account on these platforms.
|
|
1492
1759
|
*/
|
|
1493
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
1760
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1494
1761
|
/**
|
|
1495
1762
|
* Nobody carrying any of these tags.
|
|
1496
1763
|
*/
|
|
@@ -1568,11 +1835,11 @@ type FilterGroup = {
|
|
|
1568
1835
|
/**
|
|
1569
1836
|
* Only posts from any of these platforms.
|
|
1570
1837
|
*/
|
|
1571
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
1838
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1572
1839
|
/**
|
|
1573
1840
|
* Never posts from these platforms.
|
|
1574
1841
|
*/
|
|
1575
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
1842
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1576
1843
|
/**
|
|
1577
1844
|
* Only mentions in this status: open, ignored, done.
|
|
1578
1845
|
*/
|
|
@@ -1633,6 +1900,14 @@ type FilterGroup = {
|
|
|
1633
1900
|
* Never posts linking to these hosts.
|
|
1634
1901
|
*/
|
|
1635
1902
|
notLinkHosts?: Array<string>;
|
|
1903
|
+
/**
|
|
1904
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
1905
|
+
*/
|
|
1906
|
+
subreddits?: Array<string>;
|
|
1907
|
+
/**
|
|
1908
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
1909
|
+
*/
|
|
1910
|
+
notSubreddits?: Array<string>;
|
|
1636
1911
|
/**
|
|
1637
1912
|
* Only authors with at least this many followers; unknown reach never passes.
|
|
1638
1913
|
*/
|
|
@@ -1645,6 +1920,10 @@ type FilterGroup = {
|
|
|
1645
1920
|
* true: only replies and comments; false: only top-level posts.
|
|
1646
1921
|
*/
|
|
1647
1922
|
isReply?: boolean;
|
|
1923
|
+
/**
|
|
1924
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
1925
|
+
*/
|
|
1926
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
1648
1927
|
/**
|
|
1649
1928
|
* Never these authors: display names, handles or profile URLs.
|
|
1650
1929
|
*/
|
|
@@ -1717,11 +1996,11 @@ type View = {
|
|
|
1717
1996
|
/**
|
|
1718
1997
|
* Only posts from any of these platforms.
|
|
1719
1998
|
*/
|
|
1720
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
1999
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1721
2000
|
/**
|
|
1722
2001
|
* Never posts from these platforms.
|
|
1723
2002
|
*/
|
|
1724
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
2003
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1725
2004
|
/**
|
|
1726
2005
|
* Only mentions in this status: open, ignored, done.
|
|
1727
2006
|
*/
|
|
@@ -1782,6 +2061,14 @@ type View = {
|
|
|
1782
2061
|
* Never posts linking to these hosts.
|
|
1783
2062
|
*/
|
|
1784
2063
|
notLinkHosts?: Array<string>;
|
|
2064
|
+
/**
|
|
2065
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
2066
|
+
*/
|
|
2067
|
+
subreddits?: Array<string>;
|
|
2068
|
+
/**
|
|
2069
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
2070
|
+
*/
|
|
2071
|
+
notSubreddits?: Array<string>;
|
|
1785
2072
|
/**
|
|
1786
2073
|
* Only authors with at least this many followers; unknown reach never passes.
|
|
1787
2074
|
*/
|
|
@@ -1794,6 +2081,10 @@ type View = {
|
|
|
1794
2081
|
* true: only replies and comments; false: only top-level posts.
|
|
1795
2082
|
*/
|
|
1796
2083
|
isReply?: boolean;
|
|
2084
|
+
/**
|
|
2085
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
2086
|
+
*/
|
|
2087
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
1797
2088
|
/**
|
|
1798
2089
|
* Never these authors: display names, handles or profile URLs.
|
|
1799
2090
|
*/
|
|
@@ -2323,7 +2614,7 @@ type UsageSummary = {
|
|
|
2323
2614
|
*/
|
|
2324
2615
|
cents: number;
|
|
2325
2616
|
/**
|
|
2326
|
-
* Mentions
|
|
2617
|
+
* Mentions and comments billed since the last daily settlement, priced but not yet debited.
|
|
2327
2618
|
*/
|
|
2328
2619
|
pendingCents: number;
|
|
2329
2620
|
/**
|
|
@@ -2446,24 +2737,32 @@ type UsageBreakdown = {
|
|
|
2446
2737
|
* Of the matches billed in the window (every scored match, relevant or not), the ones in this group.
|
|
2447
2738
|
*/
|
|
2448
2739
|
billableMentions: number;
|
|
2740
|
+
/**
|
|
2741
|
+
* Matches recorded in the window that are never charged: no score yet (still being scored, or classification failed), or a free review from the look-back of a newly connected app. Every other match is charged, on the mentions line or, for a comment, on the comments line.
|
|
2742
|
+
*/
|
|
2743
|
+
unclassifiedMentions: number;
|
|
2449
2744
|
/**
|
|
2450
2745
|
* The billed mentions at $0.008 each, rounded once on the total.
|
|
2451
2746
|
*/
|
|
2452
2747
|
mentionCents: number;
|
|
2453
2748
|
/**
|
|
2454
|
-
*
|
|
2749
|
+
* Comments billed in the window (the comments line): comments delivered under your mentions and comments that matched a keyword, each once per workspace.
|
|
2455
2750
|
*/
|
|
2456
|
-
|
|
2751
|
+
billableComments: number;
|
|
2457
2752
|
/**
|
|
2458
|
-
*
|
|
2753
|
+
* The billed comments at $0.008 each, rounded once on the total.
|
|
2459
2754
|
*/
|
|
2460
|
-
|
|
2755
|
+
commentCents: number;
|
|
2756
|
+
/**
|
|
2757
|
+
* keywordCents plus mentionCents plus commentCents.
|
|
2758
|
+
*/
|
|
2759
|
+
totalCents: number;
|
|
2461
2760
|
/**
|
|
2462
2761
|
* What the ledger has debited so far for the days of the window, each debit by the day it settled. Mentions settle the morning after their day, so a window ending today lags totalCents by today's mentions (and yesterday's before the tick at 00:05 UTC); a closed month differs from totalCents only by cumulative rounding.
|
|
2463
2762
|
*/
|
|
2464
2763
|
ledgerDebitCents: number;
|
|
2465
2764
|
/**
|
|
2466
|
-
* Billed mentions whose match row is gone (deleted keyword), so no platform or keyword row can claim them. Charged all the same.
|
|
2765
|
+
* Billed mentions whose match row is gone (deleted keyword), so no platform or keyword row can claim them. Charged all the same. Comments carry their keyword and platform on the billed row, so they are never unattributed (by=group puts a deleted keyword's comments on the no-group row).
|
|
2467
2766
|
*/
|
|
2468
2767
|
unattributedBillable: number;
|
|
2469
2768
|
};
|
|
@@ -2529,12 +2828,24 @@ type UsageBreakdown = {
|
|
|
2529
2828
|
* Of the matches billed in the window (every scored match, relevant or not), the ones in this group.
|
|
2530
2829
|
*/
|
|
2531
2830
|
billableMentions: number;
|
|
2831
|
+
/**
|
|
2832
|
+
* Matches recorded in the window that are never charged: no score yet (still being scored, or classification failed), or a free review from the look-back of a newly connected app. Every other match is charged, on the mentions line or, for a comment, on the comments line.
|
|
2833
|
+
*/
|
|
2834
|
+
unclassifiedMentions: number;
|
|
2532
2835
|
/**
|
|
2533
2836
|
* The billed mentions at $0.008 each, rounded once on the total.
|
|
2534
2837
|
*/
|
|
2535
2838
|
mentionCents: number;
|
|
2536
2839
|
/**
|
|
2537
|
-
*
|
|
2840
|
+
* Comments billed in the window (the comments line): comments delivered under your mentions and comments that matched a keyword, each once per workspace.
|
|
2841
|
+
*/
|
|
2842
|
+
billableComments: number;
|
|
2843
|
+
/**
|
|
2844
|
+
* The billed comments at $0.008 each, rounded once on the total.
|
|
2845
|
+
*/
|
|
2846
|
+
commentCents: number;
|
|
2847
|
+
/**
|
|
2848
|
+
* keywordCents plus mentionCents plus commentCents.
|
|
2538
2849
|
*/
|
|
2539
2850
|
totalCents: number;
|
|
2540
2851
|
}>;
|
|
@@ -2549,7 +2860,7 @@ type Wallet = {
|
|
|
2549
2860
|
*/
|
|
2550
2861
|
balanceCents: number;
|
|
2551
2862
|
/**
|
|
2552
|
-
* Mentions
|
|
2863
|
+
* Mentions and comments billed since the last daily settlement, priced but not yet debited.
|
|
2553
2864
|
*/
|
|
2554
2865
|
pendingCents: number;
|
|
2555
2866
|
/**
|
|
@@ -2662,9 +2973,9 @@ type LedgerList = {
|
|
|
2662
2973
|
*/
|
|
2663
2974
|
id: string;
|
|
2664
2975
|
/**
|
|
2665
|
-
* signup_credit, topup, refund, debit_keyword_days, debit_mentions or adjustment.
|
|
2976
|
+
* signup_credit, topup, refund, debit_keyword_days, debit_mentions, debit_comments or adjustment.
|
|
2666
2977
|
*/
|
|
2667
|
-
kind: 'signup_credit' | 'topup' | 'refund' | 'debit_keyword_days' | 'debit_mentions' | 'adjustment';
|
|
2978
|
+
kind: 'signup_credit' | 'topup' | 'refund' | 'debit_keyword_days' | 'debit_mentions' | 'debit_comments' | 'adjustment';
|
|
2668
2979
|
/**
|
|
2669
2980
|
* Integer USD cents; credits positive, debits negative.
|
|
2670
2981
|
*/
|
|
@@ -2753,7 +3064,7 @@ type Alert = {
|
|
|
2753
3064
|
/**
|
|
2754
3065
|
* Only posts from these platforms.
|
|
2755
3066
|
*/
|
|
2756
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
3067
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2757
3068
|
/**
|
|
2758
3069
|
* The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
|
|
2759
3070
|
*/
|
|
@@ -3260,17 +3571,17 @@ type AnalyticsBreakdown = {
|
|
|
3260
3571
|
/**
|
|
3261
3572
|
* The dimension the rows are grouped by.
|
|
3262
3573
|
*/
|
|
3263
|
-
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language';
|
|
3574
|
+
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'subreddit';
|
|
3264
3575
|
/**
|
|
3265
3576
|
* Most matched first, at most 50 groups. by=hour is chronological and unlimited (168 cells at most).
|
|
3266
3577
|
*/
|
|
3267
3578
|
data: Array<{
|
|
3268
3579
|
/**
|
|
3269
|
-
* The group: platform name, keyword id, sentiment, intent, status, "weekday-hour" for by=hour,
|
|
3580
|
+
* The group: platform name, keyword id, sentiment, intent, status, "weekday-hour" for by=hour, an opaque person key, or the subreddit in lowercase.
|
|
3270
3581
|
*/
|
|
3271
3582
|
key: string;
|
|
3272
3583
|
/**
|
|
3273
|
-
* Readable name: the keyword term, the person name, otherwise the key.
|
|
3584
|
+
* Readable name: the keyword term, the person name, the subreddit as Reddit spells it, otherwise the key.
|
|
3274
3585
|
*/
|
|
3275
3586
|
label: string;
|
|
3276
3587
|
/**
|
|
@@ -3304,9 +3615,9 @@ type AnalyticsBreakdown = {
|
|
|
3304
3615
|
*/
|
|
3305
3616
|
name: string | null;
|
|
3306
3617
|
/**
|
|
3307
|
-
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).
|
|
3618
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
3308
3619
|
*/
|
|
3309
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
3620
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
3310
3621
|
/**
|
|
3311
3622
|
* Profile URL.
|
|
3312
3623
|
*/
|
|
@@ -3915,7 +4226,7 @@ type ListKeywordsData = {
|
|
|
3915
4226
|
/**
|
|
3916
4227
|
* Only keywords tracked on any of these platforms: its term searched there (every platform when its platforms are null), or for appstore and googleplay, an app of that store among its reviewSources. Repeatable, or comma-separated.
|
|
3917
4228
|
*/
|
|
3918
|
-
platform?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
4229
|
+
platform?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
3919
4230
|
/**
|
|
3920
4231
|
* newest: created most recently first. oldest: the reverse. term: A to Z. mentions: most matches first. relevant: most relevant matches first. recent: most matches in the last 7 days first. lastMention: newest matched post first, keywords with none last.
|
|
3921
4232
|
*/
|
|
@@ -3975,7 +4286,7 @@ type ListKeywordsResponses = {
|
|
|
3975
4286
|
*/
|
|
3976
4287
|
cap: {
|
|
3977
4288
|
/**
|
|
3978
|
-
*
|
|
4289
|
+
* Charged items allowed per calendar month (UTC): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
3979
4290
|
*/
|
|
3980
4291
|
mentions: number;
|
|
3981
4292
|
/**
|
|
@@ -3987,11 +4298,28 @@ type ListKeywordsResponses = {
|
|
|
3987
4298
|
*/
|
|
3988
4299
|
own: number | null;
|
|
3989
4300
|
} | null;
|
|
4301
|
+
/**
|
|
4302
|
+
* Comments under this keyword's mentions: when enabled, the comments of every mention scored relevant are read from 30 minutes after the post, on a schedule per platform (for a day on Reddit, Hacker News and Bluesky, a week on GitHub, Stack Overflow and DEV, a month on YouTube) (new comments only, at most maxPerPost a thread, comments of fewer than three words dropped), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments.
|
|
4303
|
+
*/
|
|
4304
|
+
comments: {
|
|
4305
|
+
/**
|
|
4306
|
+
* Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
|
|
4307
|
+
*/
|
|
4308
|
+
enabled: boolean;
|
|
4309
|
+
/**
|
|
4310
|
+
* The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
|
|
4311
|
+
*/
|
|
4312
|
+
maxPerPost: number;
|
|
4313
|
+
};
|
|
3990
4314
|
group: GroupRef;
|
|
3991
4315
|
/**
|
|
3992
4316
|
* Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
|
|
3993
4317
|
*/
|
|
3994
4318
|
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
4319
|
+
/**
|
|
4320
|
+
* RSS and Atom feeds this keyword reads; empty for none.
|
|
4321
|
+
*/
|
|
4322
|
+
feeds: Array<KeywordFeed>;
|
|
3995
4323
|
/**
|
|
3996
4324
|
* Where this keyword collects reviews from (App Store and Google Play apps, Trustpilot pages, Google Maps places); empty for none.
|
|
3997
4325
|
*/
|
|
@@ -4028,6 +4356,36 @@ type ListKeywordsResponses = {
|
|
|
4028
4356
|
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
4029
4357
|
*/
|
|
4030
4358
|
exactPhrase: boolean;
|
|
4359
|
+
/**
|
|
4360
|
+
* Reddit only, for this keyword alone; the workspace filters' own subreddit lists (GET /v1/filters) still apply to every keyword, and a post must pass both.
|
|
4361
|
+
*/
|
|
4362
|
+
subreddits: {
|
|
4363
|
+
/**
|
|
4364
|
+
* When non-empty, this keyword takes Reddit posts from these subreddits ONLY and `excluded` is ignored. r/name or name, stored bare and lowercase.
|
|
4365
|
+
*/
|
|
4366
|
+
only: Array<string>;
|
|
4367
|
+
/**
|
|
4368
|
+
* Reddit posts from these subreddits are dropped for this keyword. r/name or name.
|
|
4369
|
+
*/
|
|
4370
|
+
excluded: Array<string>;
|
|
4371
|
+
};
|
|
4372
|
+
/**
|
|
4373
|
+
* GitHub only: which repository events naming this keyword become mentions. An event outside the rule is dropped before it is stored, so it is never billed.
|
|
4374
|
+
*/
|
|
4375
|
+
repositories: {
|
|
4376
|
+
/**
|
|
4377
|
+
* The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
|
|
4378
|
+
*/
|
|
4379
|
+
events: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
4380
|
+
/**
|
|
4381
|
+
* Only repositories with at least this many stars; null for no minimum.
|
|
4382
|
+
*/
|
|
4383
|
+
minStars: number | null;
|
|
4384
|
+
/**
|
|
4385
|
+
* Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
|
|
4386
|
+
*/
|
|
4387
|
+
minWeeklyStars: number | null;
|
|
4388
|
+
};
|
|
4031
4389
|
};
|
|
4032
4390
|
/**
|
|
4033
4391
|
* Computed over this workspace's matches.
|
|
@@ -4046,7 +4404,7 @@ type ListKeywordsResponses = {
|
|
|
4046
4404
|
*/
|
|
4047
4405
|
last7d: number;
|
|
4048
4406
|
/**
|
|
4049
|
-
* Matches recorded this calendar month (UTC), the count a cap compares against.
|
|
4407
|
+
* Matches recorded this calendar month (UTC), plus the thread comments delivered under this keyword's mentions: the count a cap compares against.
|
|
4050
4408
|
*/
|
|
4051
4409
|
thisMonth: number;
|
|
4052
4410
|
/**
|
|
@@ -4108,7 +4466,15 @@ type ListKeywordsResponses = {
|
|
|
4108
4466
|
*/
|
|
4109
4467
|
mentionCents: number;
|
|
4110
4468
|
/**
|
|
4111
|
-
*
|
|
4469
|
+
* Comments billed this month under this keyword: comments delivered in its threads and comments it matched, each once per workspace.
|
|
4470
|
+
*/
|
|
4471
|
+
billableComments: number;
|
|
4472
|
+
/**
|
|
4473
|
+
* Those comments at $0.008 each, rounded once on the total.
|
|
4474
|
+
*/
|
|
4475
|
+
commentCents: number;
|
|
4476
|
+
/**
|
|
4477
|
+
* keywordCents plus mentionCents plus commentCents: what this keyword has cost this month, in USD cents.
|
|
4112
4478
|
*/
|
|
4113
4479
|
totalCents: number;
|
|
4114
4480
|
};
|
|
@@ -4118,9 +4484,9 @@ type ListKeywordsResponses = {
|
|
|
4118
4484
|
*/
|
|
4119
4485
|
polling: Array<{
|
|
4120
4486
|
/**
|
|
4121
|
-
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).
|
|
4487
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
4122
4488
|
*/
|
|
4123
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
4489
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
4124
4490
|
/**
|
|
4125
4491
|
* Newest poll of this platform for the term; null until the first one.
|
|
4126
4492
|
*/
|
|
@@ -4153,7 +4519,7 @@ type CreateKeywordData = {
|
|
|
4153
4519
|
*/
|
|
4154
4520
|
kind?: 'brand' | 'competitor' | 'topic';
|
|
4155
4521
|
/**
|
|
4156
|
-
* Platforms to search the term on; omit or null for every platform. [] searches it nowhere: a keyword that only collects reviews, which then needs reviewSources.
|
|
4522
|
+
* Platforms to search the term on; omit or null for every platform. [] searches it nowhere: a keyword that only collects reviews or reads feeds, which then needs reviewSources or feeds.
|
|
4157
4523
|
*/
|
|
4158
4524
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
4159
4525
|
/**
|
|
@@ -4188,16 +4554,59 @@ type CreateKeywordData = {
|
|
|
4188
4554
|
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
4189
4555
|
*/
|
|
4190
4556
|
exactPhrase?: boolean;
|
|
4557
|
+
/**
|
|
4558
|
+
* GitHub only: each field is replaced when sent, kept when omitted; null clears a minimum.
|
|
4559
|
+
*/
|
|
4560
|
+
repositories?: {
|
|
4561
|
+
/**
|
|
4562
|
+
* The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
|
|
4563
|
+
*/
|
|
4564
|
+
events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
4565
|
+
/**
|
|
4566
|
+
* Only repositories with at least this many stars; null for no minimum.
|
|
4567
|
+
*/
|
|
4568
|
+
minStars?: number | null;
|
|
4569
|
+
/**
|
|
4570
|
+
* Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
|
|
4571
|
+
*/
|
|
4572
|
+
minWeeklyStars?: number | null;
|
|
4573
|
+
};
|
|
4574
|
+
/**
|
|
4575
|
+
* Reddit only, for this keyword alone: each list is replaced when sent, kept when omitted.
|
|
4576
|
+
*/
|
|
4577
|
+
subreddits?: {
|
|
4578
|
+
/**
|
|
4579
|
+
* Replaces the keyword's allowlist; [] clears it.
|
|
4580
|
+
*/
|
|
4581
|
+
only?: Array<string>;
|
|
4582
|
+
/**
|
|
4583
|
+
* Replaces the keyword's deny list; [] clears it.
|
|
4584
|
+
*/
|
|
4585
|
+
excluded?: Array<string>;
|
|
4586
|
+
};
|
|
4191
4587
|
};
|
|
4192
4588
|
/**
|
|
4193
4589
|
* A monthly mention cap; omit or null for none.
|
|
4194
4590
|
*/
|
|
4195
4591
|
cap?: {
|
|
4196
4592
|
/**
|
|
4197
|
-
*
|
|
4593
|
+
* Charged items allowed per calendar month (UTC): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
4198
4594
|
*/
|
|
4199
4595
|
mentions: number;
|
|
4200
4596
|
} | null;
|
|
4597
|
+
/**
|
|
4598
|
+
* Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
|
|
4599
|
+
*/
|
|
4600
|
+
comments?: {
|
|
4601
|
+
/**
|
|
4602
|
+
* Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
|
|
4603
|
+
*/
|
|
4604
|
+
enabled?: boolean;
|
|
4605
|
+
/**
|
|
4606
|
+
* The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
|
|
4607
|
+
*/
|
|
4608
|
+
maxPerPost?: number;
|
|
4609
|
+
};
|
|
4201
4610
|
/**
|
|
4202
4611
|
* The group to track it in (grp_...); omit for the workspace's default group. A term may be tracked once per group.
|
|
4203
4612
|
*/
|
|
@@ -4227,6 +4636,15 @@ type CreateKeywordData = {
|
|
|
4227
4636
|
*/
|
|
4228
4637
|
language?: string;
|
|
4229
4638
|
}>;
|
|
4639
|
+
/**
|
|
4640
|
+
* RSS or Atom feeds this keyword reads, at most 20, each { url }: a feed's URL, or a page's (a forum, a community, a blog), in which case the feed the page advertises is used, else a usual address such as /feed or /rss. A URL with no feed behind it is a 400. Each feed is read every hour; an item is a mention of this keyword when it holds the term (with the keyword's matching rules), and only of keywords that named the feed. A newly connected feed brings its newest 10 items of the last 30 days that hold the term, billed like any mention and never sent as instant alerts.
|
|
4641
|
+
*/
|
|
4642
|
+
feeds?: Array<{
|
|
4643
|
+
/**
|
|
4644
|
+
* A feed's address (https://forum.example.com/posts.rss), or a page's (https://forum.example.com): the feed the page advertises is used.
|
|
4645
|
+
*/
|
|
4646
|
+
url: string;
|
|
4647
|
+
}>;
|
|
4230
4648
|
};
|
|
4231
4649
|
path?: never;
|
|
4232
4650
|
query?: never;
|
|
@@ -4361,16 +4779,59 @@ type UpdateKeywordData = {
|
|
|
4361
4779
|
* true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
|
|
4362
4780
|
*/
|
|
4363
4781
|
exactPhrase?: boolean;
|
|
4782
|
+
/**
|
|
4783
|
+
* GitHub only: each field is replaced when sent, kept when omitted; null clears a minimum.
|
|
4784
|
+
*/
|
|
4785
|
+
repositories?: {
|
|
4786
|
+
/**
|
|
4787
|
+
* The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
|
|
4788
|
+
*/
|
|
4789
|
+
events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
4790
|
+
/**
|
|
4791
|
+
* Only repositories with at least this many stars; null for no minimum.
|
|
4792
|
+
*/
|
|
4793
|
+
minStars?: number | null;
|
|
4794
|
+
/**
|
|
4795
|
+
* Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
|
|
4796
|
+
*/
|
|
4797
|
+
minWeeklyStars?: number | null;
|
|
4798
|
+
};
|
|
4799
|
+
/**
|
|
4800
|
+
* Reddit only, for this keyword alone: each list is replaced when sent, kept when omitted.
|
|
4801
|
+
*/
|
|
4802
|
+
subreddits?: {
|
|
4803
|
+
/**
|
|
4804
|
+
* Replaces the keyword's allowlist; [] clears it.
|
|
4805
|
+
*/
|
|
4806
|
+
only?: Array<string>;
|
|
4807
|
+
/**
|
|
4808
|
+
* Replaces the keyword's deny list; [] clears it.
|
|
4809
|
+
*/
|
|
4810
|
+
excluded?: Array<string>;
|
|
4811
|
+
};
|
|
4364
4812
|
};
|
|
4365
4813
|
/**
|
|
4366
4814
|
* Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it.
|
|
4367
4815
|
*/
|
|
4368
4816
|
cap?: {
|
|
4369
4817
|
/**
|
|
4370
|
-
*
|
|
4818
|
+
* Charged items allowed per calendar month (UTC): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
4371
4819
|
*/
|
|
4372
4820
|
mentions: number;
|
|
4373
4821
|
} | null;
|
|
4822
|
+
/**
|
|
4823
|
+
* Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
|
|
4824
|
+
*/
|
|
4825
|
+
comments?: {
|
|
4826
|
+
/**
|
|
4827
|
+
* Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
|
|
4828
|
+
*/
|
|
4829
|
+
enabled?: boolean;
|
|
4830
|
+
/**
|
|
4831
|
+
* The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
|
|
4832
|
+
*/
|
|
4833
|
+
maxPerPost?: number;
|
|
4834
|
+
};
|
|
4374
4835
|
/**
|
|
4375
4836
|
* Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
|
|
4376
4837
|
*/
|
|
@@ -4400,6 +4861,15 @@ type UpdateKeywordData = {
|
|
|
4400
4861
|
*/
|
|
4401
4862
|
language?: string;
|
|
4402
4863
|
}>;
|
|
4864
|
+
/**
|
|
4865
|
+
* Replaces the feeds this keyword reads; [] disconnects them all (their mentions stay). A feed added here is checked now and brings its newest 10 matching items of the last 30 days; one already listed keeps its place.
|
|
4866
|
+
*/
|
|
4867
|
+
feeds?: Array<{
|
|
4868
|
+
/**
|
|
4869
|
+
* A feed's address (https://forum.example.com/posts.rss), or a page's (https://forum.example.com): the feed the page advertises is used.
|
|
4870
|
+
*/
|
|
4871
|
+
url: string;
|
|
4872
|
+
}>;
|
|
4403
4873
|
};
|
|
4404
4874
|
path: {
|
|
4405
4875
|
/**
|
|
@@ -4656,7 +5126,7 @@ type SearchMentionsData = {
|
|
|
4656
5126
|
/**
|
|
4657
5127
|
* Only posts from this platform.
|
|
4658
5128
|
*/
|
|
4659
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
5129
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
4660
5130
|
/**
|
|
4661
5131
|
* Only mentions in this status. Omit for every status.
|
|
4662
5132
|
*/
|
|
@@ -4685,6 +5155,10 @@ type SearchMentionsData = {
|
|
|
4685
5155
|
* true: include mentions by people you muted, hidden by default.
|
|
4686
5156
|
*/
|
|
4687
5157
|
includeMuted?: boolean;
|
|
5158
|
+
/**
|
|
5159
|
+
* true: list cross-posts (a mention whose duplicateOf is set) as mentions of their own. By default each is listed only in its original's duplicates.
|
|
5160
|
+
*/
|
|
5161
|
+
includeDuplicates?: boolean;
|
|
4688
5162
|
/**
|
|
4689
5163
|
* Only mentions assigned to this workspace member (user id).
|
|
4690
5164
|
*/
|
|
@@ -4713,6 +5187,10 @@ type SearchMentionsData = {
|
|
|
4713
5187
|
* Only authors with at most this many followers. Unknown reach never passes.
|
|
4714
5188
|
*/
|
|
4715
5189
|
maxFollowers?: number | null;
|
|
5190
|
+
/**
|
|
5191
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository). Omitted: all.
|
|
5192
|
+
*/
|
|
5193
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
4716
5194
|
/**
|
|
4717
5195
|
* true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
|
|
4718
5196
|
*/
|
|
@@ -4740,11 +5218,11 @@ type SearchMentionsData = {
|
|
|
4740
5218
|
/**
|
|
4741
5219
|
* Only posts from any of these platforms.
|
|
4742
5220
|
*/
|
|
4743
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5221
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4744
5222
|
/**
|
|
4745
5223
|
* Never posts from these platforms.
|
|
4746
5224
|
*/
|
|
4747
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5225
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4748
5226
|
/**
|
|
4749
5227
|
* Only matches of any of these keywords.
|
|
4750
5228
|
*/
|
|
@@ -4781,6 +5259,14 @@ type SearchMentionsData = {
|
|
|
4781
5259
|
* Never posts linking to these hosts, the host itself or a subdomain of it.
|
|
4782
5260
|
*/
|
|
4783
5261
|
notLinkHosts?: Array<string> | null;
|
|
5262
|
+
/**
|
|
5263
|
+
* Only Reddit posts from any of these subreddits: subreddits=SaaS,startups (names without the r/, any case). Every other post fails it. Repeatable, or comma-separated.
|
|
5264
|
+
*/
|
|
5265
|
+
subreddits?: Array<string> | null;
|
|
5266
|
+
/**
|
|
5267
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
5268
|
+
*/
|
|
5269
|
+
notSubreddits?: Array<string> | null;
|
|
4784
5270
|
/**
|
|
4785
5271
|
* Never authors your workspace tagged with any of these.
|
|
4786
5272
|
*/
|
|
@@ -4891,7 +5377,7 @@ type ExportMentionsCsvData = {
|
|
|
4891
5377
|
/**
|
|
4892
5378
|
* Only posts from this platform.
|
|
4893
5379
|
*/
|
|
4894
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
5380
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
4895
5381
|
/**
|
|
4896
5382
|
* Only mentions in this status. Omit for every status.
|
|
4897
5383
|
*/
|
|
@@ -4920,6 +5406,10 @@ type ExportMentionsCsvData = {
|
|
|
4920
5406
|
* true: include mentions by people you muted, hidden by default.
|
|
4921
5407
|
*/
|
|
4922
5408
|
includeMuted?: boolean;
|
|
5409
|
+
/**
|
|
5410
|
+
* true: list cross-posts (a mention whose duplicateOf is set) as mentions of their own. By default each is listed only in its original's duplicates.
|
|
5411
|
+
*/
|
|
5412
|
+
includeDuplicates?: boolean;
|
|
4923
5413
|
/**
|
|
4924
5414
|
* Only mentions assigned to this workspace member (user id).
|
|
4925
5415
|
*/
|
|
@@ -4948,6 +5438,10 @@ type ExportMentionsCsvData = {
|
|
|
4948
5438
|
* Only authors with at most this many followers. Unknown reach never passes.
|
|
4949
5439
|
*/
|
|
4950
5440
|
maxFollowers?: number | null;
|
|
5441
|
+
/**
|
|
5442
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository). Omitted: all.
|
|
5443
|
+
*/
|
|
5444
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
4951
5445
|
/**
|
|
4952
5446
|
* true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
|
|
4953
5447
|
*/
|
|
@@ -4975,11 +5469,11 @@ type ExportMentionsCsvData = {
|
|
|
4975
5469
|
/**
|
|
4976
5470
|
* Only posts from any of these platforms.
|
|
4977
5471
|
*/
|
|
4978
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5472
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4979
5473
|
/**
|
|
4980
5474
|
* Never posts from these platforms.
|
|
4981
5475
|
*/
|
|
4982
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5476
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4983
5477
|
/**
|
|
4984
5478
|
* Only matches of any of these keywords.
|
|
4985
5479
|
*/
|
|
@@ -5016,6 +5510,14 @@ type ExportMentionsCsvData = {
|
|
|
5016
5510
|
* Never posts linking to these hosts, the host itself or a subdomain of it.
|
|
5017
5511
|
*/
|
|
5018
5512
|
notLinkHosts?: Array<string> | null;
|
|
5513
|
+
/**
|
|
5514
|
+
* Only Reddit posts from any of these subreddits: subreddits=SaaS,startups (names without the r/, any case). Every other post fails it. Repeatable, or comma-separated.
|
|
5515
|
+
*/
|
|
5516
|
+
subreddits?: Array<string> | null;
|
|
5517
|
+
/**
|
|
5518
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
5519
|
+
*/
|
|
5520
|
+
notSubreddits?: Array<string> | null;
|
|
5019
5521
|
/**
|
|
5020
5522
|
* Never authors your workspace tagged with any of these.
|
|
5021
5523
|
*/
|
|
@@ -5101,6 +5603,54 @@ type ExportMentionsCsvResponses = {
|
|
|
5101
5603
|
200: string;
|
|
5102
5604
|
};
|
|
5103
5605
|
type ExportMentionsCsvResponse = ExportMentionsCsvResponses[keyof ExportMentionsCsvResponses];
|
|
5606
|
+
type ListMentionCommentsData = {
|
|
5607
|
+
body?: never;
|
|
5608
|
+
path: {
|
|
5609
|
+
/**
|
|
5610
|
+
* Mention id (mm_...).
|
|
5611
|
+
*/
|
|
5612
|
+
id: string;
|
|
5613
|
+
};
|
|
5614
|
+
query?: {
|
|
5615
|
+
/**
|
|
5616
|
+
* nextCursor from the previous page.
|
|
5617
|
+
*/
|
|
5618
|
+
cursor?: string;
|
|
5619
|
+
/**
|
|
5620
|
+
* Page size, 1 to 100.
|
|
5621
|
+
*/
|
|
5622
|
+
limit?: number;
|
|
5623
|
+
};
|
|
5624
|
+
url: '/v1/mentions/{id}/comments';
|
|
5625
|
+
};
|
|
5626
|
+
type ListMentionCommentsErrors = {
|
|
5627
|
+
/**
|
|
5628
|
+
* Invalid pagination cursor
|
|
5629
|
+
*/
|
|
5630
|
+
400: ErrorResponse;
|
|
5631
|
+
/**
|
|
5632
|
+
* Missing or invalid API key
|
|
5633
|
+
*/
|
|
5634
|
+
401: ErrorResponse;
|
|
5635
|
+
/**
|
|
5636
|
+
* Mention not found
|
|
5637
|
+
*/
|
|
5638
|
+
404: ErrorResponse;
|
|
5639
|
+
};
|
|
5640
|
+
type ListMentionCommentsError = ListMentionCommentsErrors[keyof ListMentionCommentsErrors];
|
|
5641
|
+
type ListMentionCommentsResponses = {
|
|
5642
|
+
/**
|
|
5643
|
+
* One page of the thread, newest first
|
|
5644
|
+
*/
|
|
5645
|
+
200: {
|
|
5646
|
+
data: Array<MentionComment>;
|
|
5647
|
+
/**
|
|
5648
|
+
* Pass as cursor for the next page; null on the last page.
|
|
5649
|
+
*/
|
|
5650
|
+
nextCursor: string | null;
|
|
5651
|
+
};
|
|
5652
|
+
};
|
|
5653
|
+
type ListMentionCommentsResponse = ListMentionCommentsResponses[keyof ListMentionCommentsResponses];
|
|
5104
5654
|
type ExportMentionsJsonData = {
|
|
5105
5655
|
body?: never;
|
|
5106
5656
|
path?: never;
|
|
@@ -5112,7 +5662,7 @@ type ExportMentionsJsonData = {
|
|
|
5112
5662
|
/**
|
|
5113
5663
|
* Only posts from this platform.
|
|
5114
5664
|
*/
|
|
5115
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
5665
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
5116
5666
|
/**
|
|
5117
5667
|
* Only mentions in this status. Omit for every status.
|
|
5118
5668
|
*/
|
|
@@ -5141,6 +5691,10 @@ type ExportMentionsJsonData = {
|
|
|
5141
5691
|
* true: include mentions by people you muted, hidden by default.
|
|
5142
5692
|
*/
|
|
5143
5693
|
includeMuted?: boolean;
|
|
5694
|
+
/**
|
|
5695
|
+
* true: list cross-posts (a mention whose duplicateOf is set) as mentions of their own. By default each is listed only in its original's duplicates.
|
|
5696
|
+
*/
|
|
5697
|
+
includeDuplicates?: boolean;
|
|
5144
5698
|
/**
|
|
5145
5699
|
* Only mentions assigned to this workspace member (user id).
|
|
5146
5700
|
*/
|
|
@@ -5169,6 +5723,10 @@ type ExportMentionsJsonData = {
|
|
|
5169
5723
|
* Only authors with at most this many followers. Unknown reach never passes.
|
|
5170
5724
|
*/
|
|
5171
5725
|
maxFollowers?: number | null;
|
|
5726
|
+
/**
|
|
5727
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository). Omitted: all.
|
|
5728
|
+
*/
|
|
5729
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
5172
5730
|
/**
|
|
5173
5731
|
* true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
|
|
5174
5732
|
*/
|
|
@@ -5196,11 +5754,11 @@ type ExportMentionsJsonData = {
|
|
|
5196
5754
|
/**
|
|
5197
5755
|
* Only posts from any of these platforms.
|
|
5198
5756
|
*/
|
|
5199
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5757
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
5200
5758
|
/**
|
|
5201
5759
|
* Never posts from these platforms.
|
|
5202
5760
|
*/
|
|
5203
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5761
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
5204
5762
|
/**
|
|
5205
5763
|
* Only matches of any of these keywords.
|
|
5206
5764
|
*/
|
|
@@ -5237,6 +5795,14 @@ type ExportMentionsJsonData = {
|
|
|
5237
5795
|
* Never posts linking to these hosts, the host itself or a subdomain of it.
|
|
5238
5796
|
*/
|
|
5239
5797
|
notLinkHosts?: Array<string> | null;
|
|
5798
|
+
/**
|
|
5799
|
+
* Only Reddit posts from any of these subreddits: subreddits=SaaS,startups (names without the r/, any case). Every other post fails it. Repeatable, or comma-separated.
|
|
5800
|
+
*/
|
|
5801
|
+
subreddits?: Array<string> | null;
|
|
5802
|
+
/**
|
|
5803
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
5804
|
+
*/
|
|
5805
|
+
notSubreddits?: Array<string> | null;
|
|
5240
5806
|
/**
|
|
5241
5807
|
* Never authors your workspace tagged with any of these.
|
|
5242
5808
|
*/
|
|
@@ -5338,7 +5904,7 @@ type ExportPeopleCsvData = {
|
|
|
5338
5904
|
/**
|
|
5339
5905
|
* People with an account on this platform.
|
|
5340
5906
|
*/
|
|
5341
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
5907
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
5342
5908
|
/**
|
|
5343
5909
|
* Matches the display name or the profile handle or URL, case-insensitively.
|
|
5344
5910
|
*/
|
|
@@ -5366,7 +5932,7 @@ type ExportPeopleCsvData = {
|
|
|
5366
5932
|
/**
|
|
5367
5933
|
* People with an account on any of these platforms. Repeatable, or comma-separated.
|
|
5368
5934
|
*/
|
|
5369
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5935
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
5370
5936
|
/**
|
|
5371
5937
|
* People carrying any of these tags. Repeatable, or comma-separated.
|
|
5372
5938
|
*/
|
|
@@ -5394,7 +5960,7 @@ type ExportPeopleCsvData = {
|
|
|
5394
5960
|
/**
|
|
5395
5961
|
* Nobody with an account on these platforms. Repeatable, or comma-separated.
|
|
5396
5962
|
*/
|
|
5397
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
5963
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
5398
5964
|
/**
|
|
5399
5965
|
* Nobody carrying any of these tags. Repeatable, or comma-separated.
|
|
5400
5966
|
*/
|
|
@@ -5471,7 +6037,7 @@ type ListPeopleData = {
|
|
|
5471
6037
|
/**
|
|
5472
6038
|
* People with an account on this platform.
|
|
5473
6039
|
*/
|
|
5474
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
6040
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
5475
6041
|
/**
|
|
5476
6042
|
* Matches the display name or the profile handle or URL, case-insensitively.
|
|
5477
6043
|
*/
|
|
@@ -5499,7 +6065,7 @@ type ListPeopleData = {
|
|
|
5499
6065
|
/**
|
|
5500
6066
|
* People with an account on any of these platforms. Repeatable, or comma-separated.
|
|
5501
6067
|
*/
|
|
5502
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6068
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
5503
6069
|
/**
|
|
5504
6070
|
* People carrying any of these tags. Repeatable, or comma-separated.
|
|
5505
6071
|
*/
|
|
@@ -5527,7 +6093,7 @@ type ListPeopleData = {
|
|
|
5527
6093
|
/**
|
|
5528
6094
|
* Nobody with an account on these platforms. Repeatable, or comma-separated.
|
|
5529
6095
|
*/
|
|
5530
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6096
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
5531
6097
|
/**
|
|
5532
6098
|
* Nobody carrying any of these tags. Repeatable, or comma-separated.
|
|
5533
6099
|
*/
|
|
@@ -5607,7 +6173,7 @@ type ListPeopleResponses = {
|
|
|
5607
6173
|
/**
|
|
5608
6174
|
* Platform of the canonical account; `accounts` lists every account.
|
|
5609
6175
|
*/
|
|
5610
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
6176
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
5611
6177
|
/**
|
|
5612
6178
|
* Display name as of their newest post; null when the platform has none.
|
|
5613
6179
|
*/
|
|
@@ -5630,9 +6196,9 @@ type ListPeopleResponses = {
|
|
|
5630
6196
|
*/
|
|
5631
6197
|
id: string;
|
|
5632
6198
|
/**
|
|
5633
|
-
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).
|
|
6199
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
5634
6200
|
*/
|
|
5635
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
6201
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
5636
6202
|
/**
|
|
5637
6203
|
* Display name as the platform reports it.
|
|
5638
6204
|
*/
|
|
@@ -6072,7 +6638,7 @@ type ListSegmentsResponses = {
|
|
|
6072
6638
|
/**
|
|
6073
6639
|
* People with an account on any of these platforms.
|
|
6074
6640
|
*/
|
|
6075
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6641
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6076
6642
|
/**
|
|
6077
6643
|
* People carrying any of these tags.
|
|
6078
6644
|
*/
|
|
@@ -6108,7 +6674,7 @@ type ListSegmentsResponses = {
|
|
|
6108
6674
|
/**
|
|
6109
6675
|
* Nobody with an account on these platforms.
|
|
6110
6676
|
*/
|
|
6111
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6677
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6112
6678
|
/**
|
|
6113
6679
|
* Nobody carrying any of these tags.
|
|
6114
6680
|
*/
|
|
@@ -6166,7 +6732,7 @@ type ListSegmentsResponses = {
|
|
|
6166
6732
|
/**
|
|
6167
6733
|
* People with an account on any of these platforms.
|
|
6168
6734
|
*/
|
|
6169
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6735
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6170
6736
|
/**
|
|
6171
6737
|
* People carrying any of these tags.
|
|
6172
6738
|
*/
|
|
@@ -6202,7 +6768,7 @@ type ListSegmentsResponses = {
|
|
|
6202
6768
|
/**
|
|
6203
6769
|
* Nobody with an account on these platforms.
|
|
6204
6770
|
*/
|
|
6205
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6771
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6206
6772
|
/**
|
|
6207
6773
|
* Nobody carrying any of these tags.
|
|
6208
6774
|
*/
|
|
@@ -6248,7 +6814,7 @@ type CreateSegmentData = {
|
|
|
6248
6814
|
/**
|
|
6249
6815
|
* People with an account on any of these platforms.
|
|
6250
6816
|
*/
|
|
6251
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6817
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6252
6818
|
/**
|
|
6253
6819
|
* People carrying any of these tags.
|
|
6254
6820
|
*/
|
|
@@ -6284,7 +6850,7 @@ type CreateSegmentData = {
|
|
|
6284
6850
|
/**
|
|
6285
6851
|
* Nobody with an account on these platforms.
|
|
6286
6852
|
*/
|
|
6287
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6853
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6288
6854
|
/**
|
|
6289
6855
|
* Nobody carrying any of these tags.
|
|
6290
6856
|
*/
|
|
@@ -6417,7 +6983,7 @@ type UpdateSegmentData = {
|
|
|
6417
6983
|
/**
|
|
6418
6984
|
* People with an account on any of these platforms.
|
|
6419
6985
|
*/
|
|
6420
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
6986
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6421
6987
|
/**
|
|
6422
6988
|
* People carrying any of these tags.
|
|
6423
6989
|
*/
|
|
@@ -6453,7 +7019,7 @@ type UpdateSegmentData = {
|
|
|
6453
7019
|
/**
|
|
6454
7020
|
* Nobody with an account on these platforms.
|
|
6455
7021
|
*/
|
|
6456
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
7022
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6457
7023
|
/**
|
|
6458
7024
|
* Nobody carrying any of these tags.
|
|
6459
7025
|
*/
|
|
@@ -6575,11 +7141,11 @@ type ListViewsResponses = {
|
|
|
6575
7141
|
/**
|
|
6576
7142
|
* Only posts from any of these platforms.
|
|
6577
7143
|
*/
|
|
6578
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
7144
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6579
7145
|
/**
|
|
6580
7146
|
* Never posts from these platforms.
|
|
6581
7147
|
*/
|
|
6582
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
7148
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6583
7149
|
/**
|
|
6584
7150
|
* Only mentions in this status: open, ignored, done.
|
|
6585
7151
|
*/
|
|
@@ -6640,6 +7206,14 @@ type ListViewsResponses = {
|
|
|
6640
7206
|
* Never posts linking to these hosts.
|
|
6641
7207
|
*/
|
|
6642
7208
|
notLinkHosts?: Array<string>;
|
|
7209
|
+
/**
|
|
7210
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
7211
|
+
*/
|
|
7212
|
+
subreddits?: Array<string>;
|
|
7213
|
+
/**
|
|
7214
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
7215
|
+
*/
|
|
7216
|
+
notSubreddits?: Array<string>;
|
|
6643
7217
|
/**
|
|
6644
7218
|
* Only authors with at least this many followers; unknown reach never passes.
|
|
6645
7219
|
*/
|
|
@@ -6652,6 +7226,10 @@ type ListViewsResponses = {
|
|
|
6652
7226
|
* true: only replies and comments; false: only top-level posts.
|
|
6653
7227
|
*/
|
|
6654
7228
|
isReply?: boolean;
|
|
7229
|
+
/**
|
|
7230
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
7231
|
+
*/
|
|
7232
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
6655
7233
|
/**
|
|
6656
7234
|
* Never these authors: display names, handles or profile URLs.
|
|
6657
7235
|
*/
|
|
@@ -6746,11 +7324,11 @@ type CreateViewData = {
|
|
|
6746
7324
|
/**
|
|
6747
7325
|
* Only posts from any of these platforms.
|
|
6748
7326
|
*/
|
|
6749
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
7327
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6750
7328
|
/**
|
|
6751
7329
|
* Never posts from these platforms.
|
|
6752
7330
|
*/
|
|
6753
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
7331
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6754
7332
|
/**
|
|
6755
7333
|
* Only mentions in this status: open, ignored, done.
|
|
6756
7334
|
*/
|
|
@@ -6811,6 +7389,14 @@ type CreateViewData = {
|
|
|
6811
7389
|
* Never posts linking to these hosts.
|
|
6812
7390
|
*/
|
|
6813
7391
|
notLinkHosts?: Array<string>;
|
|
7392
|
+
/**
|
|
7393
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
7394
|
+
*/
|
|
7395
|
+
subreddits?: Array<string>;
|
|
7396
|
+
/**
|
|
7397
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
7398
|
+
*/
|
|
7399
|
+
notSubreddits?: Array<string>;
|
|
6814
7400
|
/**
|
|
6815
7401
|
* Only authors with at least this many followers; unknown reach never passes.
|
|
6816
7402
|
*/
|
|
@@ -6823,6 +7409,10 @@ type CreateViewData = {
|
|
|
6823
7409
|
* true: only replies and comments; false: only top-level posts.
|
|
6824
7410
|
*/
|
|
6825
7411
|
isReply?: boolean;
|
|
7412
|
+
/**
|
|
7413
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
7414
|
+
*/
|
|
7415
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
6826
7416
|
/**
|
|
6827
7417
|
* Never these authors: display names, handles or profile URLs.
|
|
6828
7418
|
*/
|
|
@@ -6984,11 +7574,11 @@ type UpdateViewData = {
|
|
|
6984
7574
|
/**
|
|
6985
7575
|
* Only posts from any of these platforms.
|
|
6986
7576
|
*/
|
|
6987
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
7577
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6988
7578
|
/**
|
|
6989
7579
|
* Never posts from these platforms.
|
|
6990
7580
|
*/
|
|
6991
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
7581
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6992
7582
|
/**
|
|
6993
7583
|
* Only mentions in this status: open, ignored, done.
|
|
6994
7584
|
*/
|
|
@@ -7049,6 +7639,14 @@ type UpdateViewData = {
|
|
|
7049
7639
|
* Never posts linking to these hosts.
|
|
7050
7640
|
*/
|
|
7051
7641
|
notLinkHosts?: Array<string>;
|
|
7642
|
+
/**
|
|
7643
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
7644
|
+
*/
|
|
7645
|
+
subreddits?: Array<string>;
|
|
7646
|
+
/**
|
|
7647
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
7648
|
+
*/
|
|
7649
|
+
notSubreddits?: Array<string>;
|
|
7052
7650
|
/**
|
|
7053
7651
|
* Only authors with at least this many followers; unknown reach never passes.
|
|
7054
7652
|
*/
|
|
@@ -7061,6 +7659,10 @@ type UpdateViewData = {
|
|
|
7061
7659
|
* true: only replies and comments; false: only top-level posts.
|
|
7062
7660
|
*/
|
|
7063
7661
|
isReply?: boolean;
|
|
7662
|
+
/**
|
|
7663
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
7664
|
+
*/
|
|
7665
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
7064
7666
|
/**
|
|
7065
7667
|
* Never these authors: display names, handles or profile URLs.
|
|
7066
7668
|
*/
|
|
@@ -8126,7 +8728,7 @@ type UpdateAlertData = {
|
|
|
8126
8728
|
/**
|
|
8127
8729
|
* Only posts from these platforms.
|
|
8128
8730
|
*/
|
|
8129
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
8731
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8130
8732
|
/**
|
|
8131
8733
|
* The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
|
|
8132
8734
|
*/
|
|
@@ -8295,7 +8897,7 @@ type ListAlertsResponses = {
|
|
|
8295
8897
|
/**
|
|
8296
8898
|
* Only posts from these platforms.
|
|
8297
8899
|
*/
|
|
8298
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
8900
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8299
8901
|
/**
|
|
8300
8902
|
* The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
|
|
8301
8903
|
*/
|
|
@@ -8440,7 +9042,7 @@ type CreateAlertData = {
|
|
|
8440
9042
|
/**
|
|
8441
9043
|
* Only posts from these platforms.
|
|
8442
9044
|
*/
|
|
8443
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
9045
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8444
9046
|
/**
|
|
8445
9047
|
* The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
|
|
8446
9048
|
*/
|
|
@@ -8743,7 +9345,7 @@ type GetAnalyticsSummaryData = {
|
|
|
8743
9345
|
/**
|
|
8744
9346
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
8745
9347
|
*/
|
|
8746
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
9348
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8747
9349
|
/**
|
|
8748
9350
|
* true adds the period of the same length right before the window as `previous`.
|
|
8749
9351
|
*/
|
|
@@ -8796,7 +9398,7 @@ type GetAnalyticsSeriesData = {
|
|
|
8796
9398
|
/**
|
|
8797
9399
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
8798
9400
|
*/
|
|
8799
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
9401
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8800
9402
|
/**
|
|
8801
9403
|
* true adds the period of the same length right before the window as `previous`.
|
|
8802
9404
|
*/
|
|
@@ -8857,7 +9459,7 @@ type GetAnalyticsBreakdownData = {
|
|
|
8857
9459
|
/**
|
|
8858
9460
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
8859
9461
|
*/
|
|
8860
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
9462
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8861
9463
|
/**
|
|
8862
9464
|
* true adds the period of the same length right before the window as `previous`.
|
|
8863
9465
|
*/
|
|
@@ -8867,9 +9469,9 @@ type GetAnalyticsBreakdownData = {
|
|
|
8867
9469
|
*/
|
|
8868
9470
|
timezone?: string;
|
|
8869
9471
|
/**
|
|
8870
|
-
* 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).
|
|
9472
|
+
* 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), subreddit (Reddit posts only, most active first; `share` stays a percent of the whole window, every platform included).
|
|
8871
9473
|
*/
|
|
8872
|
-
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language';
|
|
9474
|
+
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'subreddit';
|
|
8873
9475
|
};
|
|
8874
9476
|
url: '/v1/analytics/breakdown';
|
|
8875
9477
|
};
|
|
@@ -8914,7 +9516,7 @@ type GetShareOfVoiceData = {
|
|
|
8914
9516
|
/**
|
|
8915
9517
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
8916
9518
|
*/
|
|
8917
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
9519
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8918
9520
|
/**
|
|
8919
9521
|
* true adds the period of the same length right before the window as `previous`.
|
|
8920
9522
|
*/
|
|
@@ -8967,7 +9569,7 @@ type GetReviewsReportData = {
|
|
|
8967
9569
|
/**
|
|
8968
9570
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
8969
9571
|
*/
|
|
8970
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
9572
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8971
9573
|
/**
|
|
8972
9574
|
* true adds the period of the same length right before the window as `previous`.
|
|
8973
9575
|
*/
|
|
@@ -9387,9 +9989,15 @@ declare const searchMentions: <ThrowOnError extends boolean = false>(options?: O
|
|
|
9387
9989
|
/**
|
|
9388
9990
|
* Export mentions as CSV
|
|
9389
9991
|
*
|
|
9390
|
-
* 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), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them). 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.
|
|
9992
|
+
* 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), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them), kind (post or comment), parent_url (the post a comment answers) and comments (comments of it delivered to you). 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.
|
|
9391
9993
|
*/
|
|
9392
9994
|
declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
|
|
9995
|
+
/**
|
|
9996
|
+
* List the comments of a mention
|
|
9997
|
+
*
|
|
9998
|
+
* The comments under a mention's post, newest first: every comment in the thread, whether or not it names your keyword. Read once, about a day after the post, for mentions scored relevant whose keyword has comments enabled (keywords.comments), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit; empty before that and for other keywords. Each comment delivered costs $0.008 on the comments line of the bill, once per workspace. A comment that itself names one of your keywords is also a mention: `mentionId` links it. Two mentions of one post (two keywords) list the same thread.
|
|
9999
|
+
*/
|
|
10000
|
+
declare const listMentionComments: <ThrowOnError extends boolean = false>(options: Options<ListMentionCommentsData, ThrowOnError>) => RequestResult<ListMentionCommentsResponses, ListMentionCommentsErrors, ThrowOnError>;
|
|
9393
10001
|
/**
|
|
9394
10002
|
* Export mentions as JSON
|
|
9395
10003
|
*
|
|
@@ -9806,6 +10414,7 @@ declare const sdk_listInvoices: typeof listInvoices;
|
|
|
9806
10414
|
declare const sdk_listKeywords: typeof listKeywords;
|
|
9807
10415
|
declare const sdk_listLedger: typeof listLedger;
|
|
9808
10416
|
declare const sdk_listMembers: typeof listMembers;
|
|
10417
|
+
declare const sdk_listMentionComments: typeof listMentionComments;
|
|
9809
10418
|
declare const sdk_listPeople: typeof listPeople;
|
|
9810
10419
|
declare const sdk_listPersonActivities: typeof listPersonActivities;
|
|
9811
10420
|
declare const sdk_listSegments: typeof listSegments;
|
|
@@ -9835,7 +10444,7 @@ declare const sdk_updateSegment: typeof updateSegment;
|
|
|
9835
10444
|
declare const sdk_updateView: typeof updateView;
|
|
9836
10445
|
declare const sdk_whoami: typeof whoami;
|
|
9837
10446
|
declare namespace sdk {
|
|
9838
|
-
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_dismissAttention as dismissAttention, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, 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_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_listViews as listViews, 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_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
|
|
10447
|
+
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_dismissAttention as dismissAttention, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, 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_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listMentionComments as listMentionComments, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_listViews as listViews, 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_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
|
|
9839
10448
|
}
|
|
9840
10449
|
|
|
9841
10450
|
/**
|
|
@@ -9863,4 +10472,4 @@ type Mentio = typeof sdk & {
|
|
|
9863
10472
|
};
|
|
9864
10473
|
declare function createMentio(options: MentioOptions): Mentio;
|
|
9865
10474
|
|
|
9866
|
-
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type AttentionItem, type Channel, type ChannelFailingEventData, 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 CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, 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 CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, 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 DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, 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 DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type DismissAttentionData, type DismissAttentionError, type DismissAttentionErrors, type DismissAttentionResponse, type DismissAttentionResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type FilterGroup, 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 GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, 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 GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type Invitation, type InvoiceList, type Keyword, type KeywordHealth, type KeywordNoisyEventData, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListAttentionData, type ListAttentionError, type ListAttentionErrors, type ListAttentionResponse, type ListAttentionResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, 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 ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MentionSpikeEventData, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type NegativeSpikeEventData, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, 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 UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, 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 UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|
|
10475
|
+
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type AttentionItem, type Channel, type ChannelFailingEventData, 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 CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, 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 CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, 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 DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, 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 DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type DismissAttentionData, type DismissAttentionError, type DismissAttentionErrors, type DismissAttentionResponse, type DismissAttentionResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type FilterGroup, 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 GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, 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 GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type Invitation, type InvoiceList, type Keyword, type KeywordFeed, type KeywordHealth, type KeywordNoisyEventData, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListAttentionData, type ListAttentionError, type ListAttentionErrors, type ListAttentionResponse, type ListAttentionResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListMentionCommentsData, type ListMentionCommentsError, type ListMentionCommentsErrors, type ListMentionCommentsResponse, type ListMentionCommentsResponses, 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 ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MentionComment, type MentionSpikeEventData, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type NegativeSpikeEventData, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, 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 UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, 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 UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|