@mentio-dev/sdk 0.14.1 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +923 -350
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -407,7 +407,7 @@ type Keyword = {
|
|
|
407
407
|
*/
|
|
408
408
|
pausedForBalance: boolean;
|
|
409
409
|
/**
|
|
410
|
-
* Muted by the noise brake:
|
|
410
|
+
* Muted by the noise brake: under 30% of 20 or more scored matches were relevant, on welcome credit. Changing its rules, platforms or context, or unmuting, resumes it (balance permitting); a top-up does not. See [Billing](/billing).
|
|
411
411
|
*/
|
|
412
412
|
pausedForNoise: boolean;
|
|
413
413
|
/**
|
|
@@ -423,7 +423,7 @@ type Keyword = {
|
|
|
423
423
|
*/
|
|
424
424
|
mentions: number;
|
|
425
425
|
/**
|
|
426
|
-
* The period the cap counts in, in UTC: day
|
|
426
|
+
* The period the cap counts in, in UTC: day, week (from Monday) or calendar month (the default). At the cap the keyword stops until the next period starts.
|
|
427
427
|
*/
|
|
428
428
|
per?: 'day' | 'week' | 'month';
|
|
429
429
|
/**
|
|
@@ -448,45 +448,45 @@ type Keyword = {
|
|
|
448
448
|
resumesAt: string | null;
|
|
449
449
|
} | null;
|
|
450
450
|
/**
|
|
451
|
-
* Comments under this keyword's mentions
|
|
451
|
+
* Comments under this keyword's relevant mentions, read several times per thread on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments; see [Comments](/guides/comments).
|
|
452
452
|
*/
|
|
453
453
|
comments: {
|
|
454
454
|
/**
|
|
455
|
-
* Read the comments under this keyword's relevant mentions
|
|
455
|
+
* Read the comments under this keyword's relevant mentions. Each comment delivered costs $0.008; comments under three words are dropped, never billed. See [Comments](/guides/comments).
|
|
456
456
|
*/
|
|
457
457
|
enabled: boolean;
|
|
458
458
|
/**
|
|
459
|
-
* The newest comments of one thread you receive
|
|
459
|
+
* The newest comments of one thread you receive: the ceiling on what one mention's comments can cost. A comment naming the keyword is a mention only among these.
|
|
460
460
|
*/
|
|
461
461
|
maxPerPost: number;
|
|
462
462
|
};
|
|
463
463
|
/**
|
|
464
|
-
* Which of this keyword's mentions you see, by language and country.
|
|
464
|
+
* Which of this keyword's mentions you see, by language and country. A hidden post is still matched, classified and billed, but kept out of lists, exports, search, alerts and digests (includeHidden=true shows it). See [Keywords](/guides/keywords#show-only-some-languages-or-countries).
|
|
465
465
|
*/
|
|
466
466
|
display: {
|
|
467
467
|
/**
|
|
468
|
-
* By the language the post is written in.
|
|
468
|
+
* By the language the post is written in (ISO 639-1).
|
|
469
469
|
*/
|
|
470
470
|
languages: {
|
|
471
471
|
/**
|
|
472
|
-
* When non-empty, a post whose language
|
|
472
|
+
* When non-empty, a post whose language is known and not listed is hidden, one the classifier cannot name included. A post whose language nobody could tell is always shown.
|
|
473
473
|
*/
|
|
474
474
|
only: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
475
475
|
/**
|
|
476
|
-
* A post whose language
|
|
476
|
+
* A post whose language is listed is hidden.
|
|
477
477
|
*/
|
|
478
478
|
excluded: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
479
479
|
};
|
|
480
480
|
/**
|
|
481
|
-
* By where the author is, as the classifier read their profile and the post.
|
|
481
|
+
* By where the author is (ISO 3166-1 alpha-2), as the classifier read their profile and the post.
|
|
482
482
|
*/
|
|
483
483
|
countries: {
|
|
484
484
|
/**
|
|
485
|
-
* When non-empty, a post whose author's country
|
|
485
|
+
* When non-empty, a post whose author's country is known and not listed is hidden, one the classifier cannot name included. A post whose author's country nobody could tell is always shown.
|
|
486
486
|
*/
|
|
487
487
|
only: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
488
488
|
/**
|
|
489
|
-
* A post whose author's country
|
|
489
|
+
* A post whose author's country is listed is hidden.
|
|
490
490
|
*/
|
|
491
491
|
excluded: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
492
492
|
};
|
|
@@ -495,7 +495,7 @@ type Keyword = {
|
|
|
495
495
|
/**
|
|
496
496
|
* Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
|
|
497
497
|
*/
|
|
498
|
-
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
498
|
+
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook'> | null;
|
|
499
499
|
/**
|
|
500
500
|
* RSS and Atom feeds this keyword reads; empty for none.
|
|
501
501
|
*/
|
|
@@ -509,7 +509,7 @@ type Keyword = {
|
|
|
509
509
|
*/
|
|
510
510
|
reviewSources: Array<ReviewSource>;
|
|
511
511
|
/**
|
|
512
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile or
|
|
512
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or group description: what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
513
513
|
*/
|
|
514
514
|
context: string | null;
|
|
515
515
|
/**
|
|
@@ -525,7 +525,7 @@ type Keyword = {
|
|
|
525
525
|
*/
|
|
526
526
|
requiredMode: 'any' | 'all';
|
|
527
527
|
/**
|
|
528
|
-
* Combinations
|
|
528
|
+
* Combinations: the post must ALSO contain every term of at least one group (an OR of ANDs), on top of requiredTerms, with the same phrase and wildcard rules. See [Keywords](/guides/keywords#several-searches-in-one-keyword).
|
|
529
529
|
*/
|
|
530
530
|
requiredGroups: Array<Array<string>>;
|
|
531
531
|
/**
|
|
@@ -541,7 +541,7 @@ type Keyword = {
|
|
|
541
541
|
*/
|
|
542
542
|
caseSensitive: boolean;
|
|
543
543
|
/**
|
|
544
|
-
* true: only the exact phrase matches. false
|
|
544
|
+
* true: only the exact phrase matches (a term sent in double quotes sets it). false: a multi-word keyword also matches its words close together, kept and billed only when scored relevant. See [Keywords](/guides/keywords#the-exact-phrase-only).
|
|
545
545
|
*/
|
|
546
546
|
exactPhrase: boolean;
|
|
547
547
|
/**
|
|
@@ -562,7 +562,12 @@ type Keyword = {
|
|
|
562
562
|
*/
|
|
563
563
|
repositories: {
|
|
564
564
|
/**
|
|
565
|
-
* The repository events this keyword takes
|
|
565
|
+
* The repository events this keyword takes (default traction, stars, growth; empty: none). See [GitHub](/platforms/github#repositories).
|
|
566
|
+
*
|
|
567
|
+
* - traction: under 30 days old, it reached 10 stars.
|
|
568
|
+
* - stars: it passed a milestone (100, 250, 500, 1,000 ...).
|
|
569
|
+
* - growth: it gained stars fast in a week.
|
|
570
|
+
* - new: every repository created; opt in, mostly noise.
|
|
566
571
|
*/
|
|
567
572
|
events: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
568
573
|
/**
|
|
@@ -570,7 +575,7 @@ type Keyword = {
|
|
|
570
575
|
*/
|
|
571
576
|
minStars: number | null;
|
|
572
577
|
/**
|
|
573
|
-
* Only repositories that gained at least this many stars in the last 7 days
|
|
578
|
+
* Only repositories that gained at least this many stars in the last 7 days, for every event; an unknown week fails. null: growth needs 100 stars and 20% a week, other events nothing.
|
|
574
579
|
*/
|
|
575
580
|
minWeeklyStars: number | null;
|
|
576
581
|
};
|
|
@@ -630,11 +635,18 @@ type Keyword = {
|
|
|
630
635
|
noisy: boolean;
|
|
631
636
|
};
|
|
632
637
|
/**
|
|
633
|
-
* The
|
|
638
|
+
* The first status that applies over the last 14 days; see [Keyword health](/guides/keyword-health).
|
|
639
|
+
*
|
|
640
|
+
* - paused: muted.
|
|
641
|
+
* - capped: at its mention cap.
|
|
642
|
+
* - noisy: 20 or more scored matches, under 30% relevant.
|
|
643
|
+
* - new: under 7 days old, or changed lately with few scored matches.
|
|
644
|
+
* - quiet: 7 days or older, nothing relevant.
|
|
645
|
+
* - healthy: none of the above.
|
|
634
646
|
*/
|
|
635
647
|
health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
|
|
636
648
|
/**
|
|
637
|
-
* What this keyword has cost this calendar month (UTC) at list price:
|
|
649
|
+
* What this keyword has cost this calendar month (UTC) at list price: its row in GET /v1/usage/breakdown?month=<this month>. The ledger differs only by cumulative rounding.
|
|
638
650
|
*/
|
|
639
651
|
cost: {
|
|
640
652
|
/**
|
|
@@ -672,9 +684,9 @@ type Keyword = {
|
|
|
672
684
|
*/
|
|
673
685
|
polling: Array<{
|
|
674
686
|
/**
|
|
675
|
-
* 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).
|
|
687
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
676
688
|
*/
|
|
677
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
689
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
678
690
|
/**
|
|
679
691
|
* Newest poll of this platform for the term; null until the first one.
|
|
680
692
|
*/
|
|
@@ -697,7 +709,7 @@ type ErrorResponse = {
|
|
|
697
709
|
/**
|
|
698
710
|
* Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.
|
|
699
711
|
*/
|
|
700
|
-
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'hourly_email_unsupported' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'feed_unreadable' | 'feed_login_required' | 'feed_login_expired' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'filter_too_complex' | 'duplicate_view' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
712
|
+
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'idempotency_key_in_use' | 'idempotency_key_reused' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'hourly_email_unsupported' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'feed_unreadable' | 'feed_login_required' | 'feed_login_expired' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'filter_too_complex' | 'duplicate_view' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
701
713
|
/**
|
|
702
714
|
* Human-readable detail; may change between releases.
|
|
703
715
|
*/
|
|
@@ -730,7 +742,7 @@ type KeywordSuggestion = {
|
|
|
730
742
|
*/
|
|
731
743
|
patch: {
|
|
732
744
|
/**
|
|
733
|
-
* Renames the keyword: the new term is tracked from now on, with no look-back,
|
|
745
|
+
* Renames the keyword: the new term is tracked from now on, with no look-back, keeping its id, settings and old mentions. Double quotes mean the exact phrase only. 409 when its group already tracks it.
|
|
734
746
|
*/
|
|
735
747
|
term?: string;
|
|
736
748
|
/**
|
|
@@ -744,9 +756,9 @@ type KeywordSuggestion = {
|
|
|
744
756
|
/**
|
|
745
757
|
* Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).
|
|
746
758
|
*/
|
|
747
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
759
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook'> | null;
|
|
748
760
|
/**
|
|
749
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile or
|
|
761
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or group description: what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
750
762
|
*/
|
|
751
763
|
context?: string | null;
|
|
752
764
|
/**
|
|
@@ -762,7 +774,7 @@ type KeywordSuggestion = {
|
|
|
762
774
|
*/
|
|
763
775
|
requiredMode?: 'any' | 'all';
|
|
764
776
|
/**
|
|
765
|
-
* Combinations
|
|
777
|
+
* Combinations: the post must ALSO contain every term of at least one group (an OR of ANDs), on top of requiredTerms, with the same phrase and wildcard rules. See [Keywords](/guides/keywords#several-searches-in-one-keyword).
|
|
766
778
|
*/
|
|
767
779
|
requiredGroups?: Array<Array<string>>;
|
|
768
780
|
/**
|
|
@@ -778,7 +790,7 @@ type KeywordSuggestion = {
|
|
|
778
790
|
*/
|
|
779
791
|
caseSensitive?: boolean;
|
|
780
792
|
/**
|
|
781
|
-
* true: only the exact phrase matches. false
|
|
793
|
+
* true: only the exact phrase matches (a term sent in double quotes sets it). false: a multi-word keyword also matches its words close together, kept and billed only when scored relevant. See [Keywords](/guides/keywords#the-exact-phrase-only).
|
|
782
794
|
*/
|
|
783
795
|
exactPhrase?: boolean;
|
|
784
796
|
/**
|
|
@@ -786,7 +798,12 @@ type KeywordSuggestion = {
|
|
|
786
798
|
*/
|
|
787
799
|
repositories?: {
|
|
788
800
|
/**
|
|
789
|
-
* The repository events this keyword takes
|
|
801
|
+
* The repository events this keyword takes (default traction, stars, growth; empty: none). See [GitHub](/platforms/github#repositories).
|
|
802
|
+
*
|
|
803
|
+
* - traction: under 30 days old, it reached 10 stars.
|
|
804
|
+
* - stars: it passed a milestone (100, 250, 500, 1,000 ...).
|
|
805
|
+
* - growth: it gained stars fast in a week.
|
|
806
|
+
* - new: every repository created; opt in, mostly noise.
|
|
790
807
|
*/
|
|
791
808
|
events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
792
809
|
/**
|
|
@@ -794,7 +811,7 @@ type KeywordSuggestion = {
|
|
|
794
811
|
*/
|
|
795
812
|
minStars?: number | null;
|
|
796
813
|
/**
|
|
797
|
-
* Only repositories that gained at least this many stars in the last 7 days
|
|
814
|
+
* Only repositories that gained at least this many stars in the last 7 days, for every event; an unknown week fails. null: growth needs 100 stars and 20% a week, other events nothing.
|
|
798
815
|
*/
|
|
799
816
|
minWeeklyStars?: number | null;
|
|
800
817
|
};
|
|
@@ -821,7 +838,7 @@ type KeywordSuggestion = {
|
|
|
821
838
|
*/
|
|
822
839
|
mentions: number;
|
|
823
840
|
/**
|
|
824
|
-
* The period the cap counts in, in UTC: day
|
|
841
|
+
* The period the cap counts in, in UTC: day, week (from Monday) or calendar month (the default). At the cap the keyword stops until the next period starts.
|
|
825
842
|
*/
|
|
826
843
|
per?: 'day' | 'week' | 'month';
|
|
827
844
|
} | null;
|
|
@@ -830,11 +847,11 @@ type KeywordSuggestion = {
|
|
|
830
847
|
*/
|
|
831
848
|
comments?: {
|
|
832
849
|
/**
|
|
833
|
-
* Read the comments under this keyword's relevant mentions
|
|
850
|
+
* Read the comments under this keyword's relevant mentions. Each comment delivered costs $0.008; comments under three words are dropped, never billed. See [Comments](/guides/comments).
|
|
834
851
|
*/
|
|
835
852
|
enabled?: boolean;
|
|
836
853
|
/**
|
|
837
|
-
* The newest comments of one thread you receive
|
|
854
|
+
* The newest comments of one thread you receive: the ceiling on what one mention's comments can cost. A comment naming the keyword is a mention only among these.
|
|
838
855
|
*/
|
|
839
856
|
maxPerPost?: number;
|
|
840
857
|
};
|
|
@@ -890,7 +907,7 @@ type KeywordSuggestion = {
|
|
|
890
907
|
*/
|
|
891
908
|
id?: string;
|
|
892
909
|
/**
|
|
893
|
-
* App Store and Google Play
|
|
910
|
+
* App Store and Google Play storefronts to read, as two-letter codes; default the link's, else us. Each adds a daily poll; a review seen in two is one mention. Trustpilot and Google Maps take none.
|
|
894
911
|
*/
|
|
895
912
|
countries?: Array<string>;
|
|
896
913
|
/**
|
|
@@ -992,7 +1009,14 @@ type KeywordHealth = {
|
|
|
992
1009
|
days: number;
|
|
993
1010
|
};
|
|
994
1011
|
/**
|
|
995
|
-
*
|
|
1012
|
+
* The status over the window; see [Keyword health](/guides/keyword-health#status).
|
|
1013
|
+
*
|
|
1014
|
+
* - healthy: nothing to fix.
|
|
1015
|
+
* - noisy: 20 or more scored matches, under 30% relevant.
|
|
1016
|
+
* - quiet: 7 days or older, nothing relevant.
|
|
1017
|
+
* - capped: at its mention cap.
|
|
1018
|
+
* - paused: muted by you, the wallet or the noise brake.
|
|
1019
|
+
* - new: under 7 days old, or changed lately with few scored matches.
|
|
996
1020
|
*/
|
|
997
1021
|
status: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
|
|
998
1022
|
/**
|
|
@@ -1028,7 +1052,7 @@ type KeywordHealth = {
|
|
|
1028
1052
|
*/
|
|
1029
1053
|
workspaceShare: number | null;
|
|
1030
1054
|
/**
|
|
1031
|
-
* When the keyword last changed its
|
|
1055
|
+
* When the keyword last changed its rules, platforms or context (or was unmuted), inside the window: status, reasons, noise and suggestions read only matches since, the numbers the whole window. Null: no change inside it.
|
|
1032
1056
|
*/
|
|
1033
1057
|
judgedSince: string | null;
|
|
1034
1058
|
/**
|
|
@@ -1036,9 +1060,9 @@ type KeywordHealth = {
|
|
|
1036
1060
|
*/
|
|
1037
1061
|
byPlatform: Array<{
|
|
1038
1062
|
/**
|
|
1039
|
-
* 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).
|
|
1063
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
1040
1064
|
*/
|
|
1041
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1065
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1042
1066
|
/**
|
|
1043
1067
|
* Matches on this platform in the window.
|
|
1044
1068
|
*/
|
|
@@ -1201,7 +1225,7 @@ type Feed = {
|
|
|
1201
1225
|
*/
|
|
1202
1226
|
connectedAt: string;
|
|
1203
1227
|
/**
|
|
1204
|
-
* Nothing published before this is a live mention: the connection, or the last
|
|
1228
|
+
* Nothing published before this is a live mention: the connection, or the last sign-in change (signed in or out, a post reads as a new one, so it starts over rather than bill twice).
|
|
1205
1229
|
*/
|
|
1206
1230
|
readingSince: string;
|
|
1207
1231
|
/**
|
|
@@ -1331,11 +1355,11 @@ type Mention = {
|
|
|
1331
1355
|
};
|
|
1332
1356
|
post: {
|
|
1333
1357
|
/**
|
|
1334
|
-
* 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).
|
|
1358
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
1335
1359
|
*/
|
|
1336
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1360
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1337
1361
|
/**
|
|
1338
|
-
* post: a top-level post. comment:
|
|
1362
|
+
* post: a top-level post. comment: answers a post or comment (Reddit, Hacker News or YouTube comments, X or Bluesky replies, Stack Overflow answers). repository: a GitHub repository event (see post.repository).
|
|
1339
1363
|
*/
|
|
1340
1364
|
kind: 'post' | 'comment' | 'repository';
|
|
1341
1365
|
/**
|
|
@@ -1347,7 +1371,7 @@ type Mention = {
|
|
|
1347
1371
|
*/
|
|
1348
1372
|
text: string;
|
|
1349
1373
|
/**
|
|
1350
|
-
* The post's own title where the platform has one
|
|
1374
|
+
* The post's own title where the platform has one (a story, thread, issue, question, article, video or titled review). Null on X, Bluesky and LinkedIn, and for posts ingested before October 2026.
|
|
1351
1375
|
*/
|
|
1352
1376
|
title: string | null;
|
|
1353
1377
|
/**
|
|
@@ -1371,7 +1395,13 @@ type Mention = {
|
|
|
1371
1395
|
*/
|
|
1372
1396
|
name: string;
|
|
1373
1397
|
/**
|
|
1374
|
-
* What happened
|
|
1398
|
+
* What happened:
|
|
1399
|
+
*
|
|
1400
|
+
* - new: it was created.
|
|
1401
|
+
* - traction: under 30 days old, it reached 10 stars.
|
|
1402
|
+
* - stars: it passed a star milestone.
|
|
1403
|
+
* - growth: it gained stars fast in a week.
|
|
1404
|
+
* - top: among the most starred naming the keyword, from a look-back.
|
|
1375
1405
|
*/
|
|
1376
1406
|
event: 'new' | 'traction' | 'stars' | 'growth' | 'top';
|
|
1377
1407
|
/**
|
|
@@ -1392,7 +1422,7 @@ type Mention = {
|
|
|
1392
1422
|
*/
|
|
1393
1423
|
publishedAt: string;
|
|
1394
1424
|
/**
|
|
1395
|
-
*
|
|
1425
|
+
* Counts as the platform reported them at ingest, usually minutes after posting; a missing count is null. Null as a whole when a platform reports none, or before September 2026. X carries all six.
|
|
1396
1426
|
*/
|
|
1397
1427
|
engagement: {
|
|
1398
1428
|
likes: number | null;
|
|
@@ -1524,11 +1554,18 @@ type Mention = {
|
|
|
1524
1554
|
*/
|
|
1525
1555
|
sentiment: 'positive' | 'neutral' | 'negative';
|
|
1526
1556
|
/**
|
|
1527
|
-
* Intent and topic tags:
|
|
1557
|
+
* Intent and topic tags:
|
|
1558
|
+
*
|
|
1559
|
+
* - buy_intent, question, complaint, praise, comparison, bug_report, pricing, hiring, event, promotional.
|
|
1560
|
+
* - churn_intent: leaving or replacing the keyword.
|
|
1561
|
+
* - testimonial: a customer vouching for it from their own use.
|
|
1562
|
+
* - industry_insight: analysis or data about the field.
|
|
1563
|
+
* - launch: a product or feature launch announcement.
|
|
1564
|
+
* - feedback: a suggestion or request about it.
|
|
1528
1565
|
*/
|
|
1529
1566
|
intents: Array<string>;
|
|
1530
1567
|
/**
|
|
1531
|
-
* The post reads as machine-made
|
|
1568
|
+
* The post reads as machine-made (a bot or app account, a scheduled or templated post, an AI-written summary). A label only: it stays in the feed, delivered and billed as usual. false while unjudged.
|
|
1532
1569
|
*/
|
|
1533
1570
|
automated: boolean;
|
|
1534
1571
|
/**
|
|
@@ -1536,7 +1573,7 @@ type Mention = {
|
|
|
1536
1573
|
*/
|
|
1537
1574
|
language: string | null;
|
|
1538
1575
|
/**
|
|
1539
|
-
* Where the author is
|
|
1576
|
+
* Where the author is (lowercase ISO 3166-1 alpha-2): the classifier's best guess from profile and post. Null when unknown, outside the 60 it names, or classified before countries were recorded.
|
|
1540
1577
|
*/
|
|
1541
1578
|
country: string | null;
|
|
1542
1579
|
/**
|
|
@@ -1609,7 +1646,7 @@ type Mention = {
|
|
|
1609
1646
|
note: string | null;
|
|
1610
1647
|
};
|
|
1611
1648
|
/**
|
|
1612
|
-
*
|
|
1649
|
+
* On a cross-post (same author, text and keyword within three days), the original's id. Billed like any mention, listed only under its original, never alerted alone. null for an original. See [Cross-posts](/how-it-works#cross-posts).
|
|
1613
1650
|
*/
|
|
1614
1651
|
duplicateOf: string | null;
|
|
1615
1652
|
/**
|
|
@@ -1621,9 +1658,9 @@ type Mention = {
|
|
|
1621
1658
|
*/
|
|
1622
1659
|
id: string;
|
|
1623
1660
|
/**
|
|
1624
|
-
* 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).
|
|
1661
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
1625
1662
|
*/
|
|
1626
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1663
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1627
1664
|
/**
|
|
1628
1665
|
* Link to the copy.
|
|
1629
1666
|
*/
|
|
@@ -1686,7 +1723,7 @@ type MentionComment = {
|
|
|
1686
1723
|
*/
|
|
1687
1724
|
parentCommentId: string | null;
|
|
1688
1725
|
/**
|
|
1689
|
-
*
|
|
1726
|
+
* Counts as the platform reported them at ingest, usually minutes after posting; a missing count is null. Null as a whole when a platform reports none, or before September 2026. X carries all six.
|
|
1690
1727
|
*/
|
|
1691
1728
|
engagement: {
|
|
1692
1729
|
likes: number | null;
|
|
@@ -1722,7 +1759,7 @@ type Person = {
|
|
|
1722
1759
|
/**
|
|
1723
1760
|
* Platform of the canonical account; `accounts` lists every account.
|
|
1724
1761
|
*/
|
|
1725
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1762
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1726
1763
|
/**
|
|
1727
1764
|
* Display name as of their newest post; null when the platform has none.
|
|
1728
1765
|
*/
|
|
@@ -1745,9 +1782,9 @@ type Person = {
|
|
|
1745
1782
|
*/
|
|
1746
1783
|
id: string;
|
|
1747
1784
|
/**
|
|
1748
|
-
* 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).
|
|
1785
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
1749
1786
|
*/
|
|
1750
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1787
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
1751
1788
|
/**
|
|
1752
1789
|
* Display name as the platform reports it.
|
|
1753
1790
|
*/
|
|
@@ -1892,6 +1929,97 @@ type PersonActivity = {
|
|
|
1892
1929
|
*/
|
|
1893
1930
|
createdAt: string;
|
|
1894
1931
|
};
|
|
1932
|
+
type SegmentPreset = {
|
|
1933
|
+
/**
|
|
1934
|
+
* Stable id of the preset (influencers, champions, ...).
|
|
1935
|
+
*/
|
|
1936
|
+
key: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* Suggested segment name.
|
|
1939
|
+
*/
|
|
1940
|
+
name: string;
|
|
1941
|
+
/**
|
|
1942
|
+
* What the segment holds, in one sentence.
|
|
1943
|
+
*/
|
|
1944
|
+
description: string;
|
|
1945
|
+
/**
|
|
1946
|
+
* The filter to save with POST /v1/segments.
|
|
1947
|
+
*/
|
|
1948
|
+
filter: {
|
|
1949
|
+
/**
|
|
1950
|
+
* People with an account on any of these platforms.
|
|
1951
|
+
*/
|
|
1952
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1953
|
+
/**
|
|
1954
|
+
* People carrying any of these tags.
|
|
1955
|
+
*/
|
|
1956
|
+
tags?: Array<string>;
|
|
1957
|
+
/**
|
|
1958
|
+
* At least this many followers. Unknown reach never matches.
|
|
1959
|
+
*/
|
|
1960
|
+
minFollowers?: number;
|
|
1961
|
+
/**
|
|
1962
|
+
* At most this many followers. Unknown reach never matches.
|
|
1963
|
+
*/
|
|
1964
|
+
maxFollowers?: number;
|
|
1965
|
+
/**
|
|
1966
|
+
* At least this many matched mentions.
|
|
1967
|
+
*/
|
|
1968
|
+
minMentions?: number;
|
|
1969
|
+
/**
|
|
1970
|
+
* At least this many negative mentions.
|
|
1971
|
+
*/
|
|
1972
|
+
minNegative?: number;
|
|
1973
|
+
/**
|
|
1974
|
+
* At least one mention carrying any of these intents.
|
|
1975
|
+
*/
|
|
1976
|
+
intents?: Array<string>;
|
|
1977
|
+
/**
|
|
1978
|
+
* Mentioned a keyword of any of these kinds.
|
|
1979
|
+
*/
|
|
1980
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
1981
|
+
/**
|
|
1982
|
+
* Never mentioned a keyword of these kinds.
|
|
1983
|
+
*/
|
|
1984
|
+
neverKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
1985
|
+
/**
|
|
1986
|
+
* Nobody with an account on these platforms.
|
|
1987
|
+
*/
|
|
1988
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1989
|
+
/**
|
|
1990
|
+
* Nobody carrying any of these tags.
|
|
1991
|
+
*/
|
|
1992
|
+
notTags?: Array<string>;
|
|
1993
|
+
/**
|
|
1994
|
+
* Nobody whose mentions carry any of these intents.
|
|
1995
|
+
*/
|
|
1996
|
+
notIntents?: Array<string>;
|
|
1997
|
+
/**
|
|
1998
|
+
* First seen within this many days.
|
|
1999
|
+
*/
|
|
2000
|
+
newSinceDays?: number;
|
|
2001
|
+
/**
|
|
2002
|
+
* At least one mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
2003
|
+
*/
|
|
2004
|
+
linkHosts?: Array<string>;
|
|
2005
|
+
/**
|
|
2006
|
+
* true: only muted people; false: only unmuted.
|
|
2007
|
+
*/
|
|
2008
|
+
muted?: boolean;
|
|
2009
|
+
/**
|
|
2010
|
+
* People at any of these outreach stages.
|
|
2011
|
+
*/
|
|
2012
|
+
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
2013
|
+
/**
|
|
2014
|
+
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
|
|
2015
|
+
*/
|
|
2016
|
+
automated?: boolean;
|
|
2017
|
+
/**
|
|
2018
|
+
* People owned by any of these members (user ids); "none" matches people nobody owns.
|
|
2019
|
+
*/
|
|
2020
|
+
ownerIds?: Array<string>;
|
|
2021
|
+
};
|
|
2022
|
+
};
|
|
1895
2023
|
type Segment = {
|
|
1896
2024
|
/**
|
|
1897
2025
|
* Segment id (seg_...).
|
|
@@ -1903,7 +2031,7 @@ type Segment = {
|
|
|
1903
2031
|
/**
|
|
1904
2032
|
* People with an account on any of these platforms.
|
|
1905
2033
|
*/
|
|
1906
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2034
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1907
2035
|
/**
|
|
1908
2036
|
* People carrying any of these tags.
|
|
1909
2037
|
*/
|
|
@@ -1939,7 +2067,7 @@ type Segment = {
|
|
|
1939
2067
|
/**
|
|
1940
2068
|
* Nobody with an account on these platforms.
|
|
1941
2069
|
*/
|
|
1942
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2070
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
1943
2071
|
/**
|
|
1944
2072
|
* Nobody carrying any of these tags.
|
|
1945
2073
|
*/
|
|
@@ -2021,11 +2149,11 @@ type FilterGroup = {
|
|
|
2021
2149
|
/**
|
|
2022
2150
|
* Only posts from any of these platforms.
|
|
2023
2151
|
*/
|
|
2024
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2152
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2025
2153
|
/**
|
|
2026
2154
|
* Never posts from these platforms.
|
|
2027
2155
|
*/
|
|
2028
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2156
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2029
2157
|
/**
|
|
2030
2158
|
* Only mentions in this status: open, ignored, done.
|
|
2031
2159
|
*/
|
|
@@ -2125,6 +2253,10 @@ type FilterGroup = {
|
|
|
2125
2253
|
/**
|
|
2126
2254
|
* Never these authors: display names, handles or profile URLs.
|
|
2127
2255
|
*/
|
|
2256
|
+
notAuthors?: Array<string>;
|
|
2257
|
+
/**
|
|
2258
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
2259
|
+
*/
|
|
2128
2260
|
excludeAuthors?: Array<string>;
|
|
2129
2261
|
/**
|
|
2130
2262
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
@@ -2194,11 +2326,11 @@ type View = {
|
|
|
2194
2326
|
/**
|
|
2195
2327
|
* Only posts from any of these platforms.
|
|
2196
2328
|
*/
|
|
2197
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2329
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2198
2330
|
/**
|
|
2199
2331
|
* Never posts from these platforms.
|
|
2200
2332
|
*/
|
|
2201
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2333
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2202
2334
|
/**
|
|
2203
2335
|
* Only mentions in this status: open, ignored, done.
|
|
2204
2336
|
*/
|
|
@@ -2298,6 +2430,10 @@ type View = {
|
|
|
2298
2430
|
/**
|
|
2299
2431
|
* Never these authors: display names, handles or profile URLs.
|
|
2300
2432
|
*/
|
|
2433
|
+
notAuthors?: Array<string>;
|
|
2434
|
+
/**
|
|
2435
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
2436
|
+
*/
|
|
2301
2437
|
excludeAuthors?: Array<string>;
|
|
2302
2438
|
/**
|
|
2303
2439
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
@@ -2332,7 +2468,7 @@ type View = {
|
|
|
2332
2468
|
*/
|
|
2333
2469
|
minBookmarks?: number;
|
|
2334
2470
|
/**
|
|
2335
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
2471
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
2336
2472
|
*/
|
|
2337
2473
|
anyOf?: Array<FilterGroup>;
|
|
2338
2474
|
};
|
|
@@ -2612,7 +2748,12 @@ type FeedFailingEventData = {
|
|
|
2612
2748
|
title: string | null;
|
|
2613
2749
|
};
|
|
2614
2750
|
/**
|
|
2615
|
-
* login_required:
|
|
2751
|
+
* - login_required: a sign-in or access-denied page; add the forum's sign-in.
|
|
2752
|
+
* - login_expired: the same with a sign-in; copy a fresh cookie.
|
|
2753
|
+
* - blocked: a 403, a 429 or a bot check.
|
|
2754
|
+
* - not_found: the feed is gone.
|
|
2755
|
+
* - not_a_feed: the address answers a page, not RSS or Atom.
|
|
2756
|
+
* - unreachable: no answer or a server error.
|
|
2616
2757
|
*/
|
|
2617
2758
|
reason: 'login_required' | 'login_expired' | 'blocked' | 'not_found' | 'not_a_feed' | 'unreachable';
|
|
2618
2759
|
/**
|
|
@@ -2634,7 +2775,12 @@ type AttentionItem = {
|
|
|
2634
2775
|
*/
|
|
2635
2776
|
id: string;
|
|
2636
2777
|
/**
|
|
2637
|
-
* mention.spike: far more mentions in the last hour than
|
|
2778
|
+
* - mention.spike: far more mentions in the last hour than usual.
|
|
2779
|
+
* - sentiment.negative_spike: the negative share of the last 24 hours jumped.
|
|
2780
|
+
* - keyword.noisy: most scored matches are noise.
|
|
2781
|
+
* - channel.failing: the channel's last sends all failed.
|
|
2782
|
+
* - feed.failing: a workspace feed failed its last 3 hourly reads.
|
|
2783
|
+
* - feed.recovered: it read again after failing.
|
|
2638
2784
|
*/
|
|
2639
2785
|
kind: 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered';
|
|
2640
2786
|
/**
|
|
@@ -2995,7 +3141,7 @@ type UsageBreakdown = {
|
|
|
2995
3141
|
*/
|
|
2996
3142
|
billableMentions: number;
|
|
2997
3143
|
/**
|
|
2998
|
-
* Matches
|
|
3144
|
+
* Matches in the window that are never charged: not scored yet, classification failed, or a free review from a new app's look-back. Every other match is charged, on the mentions or comments line.
|
|
2999
3145
|
*/
|
|
3000
3146
|
unclassifiedMentions: number;
|
|
3001
3147
|
/**
|
|
@@ -3015,11 +3161,11 @@ type UsageBreakdown = {
|
|
|
3015
3161
|
*/
|
|
3016
3162
|
totalCents: number;
|
|
3017
3163
|
/**
|
|
3018
|
-
* What the ledger has debited
|
|
3164
|
+
* What the ledger has debited for the window's days, by the day each debit settled, for the whole workspace whatever the filters. Lags totalCents by unsettled mentions; see [The ledger](/billing#the-ledger).
|
|
3019
3165
|
*/
|
|
3020
3166
|
ledgerDebitCents: number;
|
|
3021
3167
|
/**
|
|
3022
|
-
* Billed mentions whose match row is gone (deleted keyword), so no platform or keyword row
|
|
3168
|
+
* Billed mentions whose match row is gone (deleted keyword), so no platform or keyword row claims them; charged all the same. Comments never are (by=group puts a deleted keyword's comments on the no-group row).
|
|
3023
3169
|
*/
|
|
3024
3170
|
unattributedBillable: number;
|
|
3025
3171
|
};
|
|
@@ -3070,7 +3216,7 @@ type UsageBreakdown = {
|
|
|
3070
3216
|
removed: boolean;
|
|
3071
3217
|
} | null;
|
|
3072
3218
|
/**
|
|
3073
|
-
* Keyword-days
|
|
3219
|
+
* Keyword-days the daily tick charged in this row. Null for by=platform and for days before the first recorded tick (unknown, not zero); before window.keywordDaysFrom a keyword row is a floor.
|
|
3074
3220
|
*/
|
|
3075
3221
|
keywordDays: number | null;
|
|
3076
3222
|
/**
|
|
@@ -3086,7 +3232,7 @@ type UsageBreakdown = {
|
|
|
3086
3232
|
*/
|
|
3087
3233
|
billableMentions: number;
|
|
3088
3234
|
/**
|
|
3089
|
-
* Matches
|
|
3235
|
+
* Matches in the window that are never charged: not scored yet, classification failed, or a free review from a new app's look-back. Every other match is charged, on the mentions or comments line.
|
|
3090
3236
|
*/
|
|
3091
3237
|
unclassifiedMentions: number;
|
|
3092
3238
|
/**
|
|
@@ -3314,7 +3460,12 @@ type Alert = {
|
|
|
3314
3460
|
name: string;
|
|
3315
3461
|
enabled: boolean;
|
|
3316
3462
|
/**
|
|
3317
|
-
*
|
|
3463
|
+
* When it sends; see [Alerts](/alerts).
|
|
3464
|
+
*
|
|
3465
|
+
* - instant: each matching mention as it happens.
|
|
3466
|
+
* - hourly: the previous UTC hour, at five past; never email.
|
|
3467
|
+
* - daily: one digest at the scheduled local time.
|
|
3468
|
+
* - weekly: one digest a week, on schedule.weekday.
|
|
3318
3469
|
*/
|
|
3319
3470
|
mode: 'instant' | 'hourly' | 'daily' | 'weekly';
|
|
3320
3471
|
filter: {
|
|
@@ -3329,9 +3480,9 @@ type Alert = {
|
|
|
3329
3480
|
/**
|
|
3330
3481
|
* Only posts from these platforms.
|
|
3331
3482
|
*/
|
|
3332
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
3483
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
3333
3484
|
/**
|
|
3334
|
-
* The rule's relevance floor. Absent
|
|
3485
|
+
* The rule's relevance floor. Absent: relevant mentions only (40 and up); lower, down to 0, it also gets noise; higher, less. Email channels keep the 40 line. Unclassified mentions never pass.
|
|
3335
3486
|
*/
|
|
3336
3487
|
minRelevance?: number;
|
|
3337
3488
|
/**
|
|
@@ -3415,7 +3566,7 @@ type Alert = {
|
|
|
3415
3566
|
*/
|
|
3416
3567
|
minBookmarks?: number;
|
|
3417
3568
|
/**
|
|
3418
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
3569
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
3419
3570
|
*/
|
|
3420
3571
|
anyOf?: Array<FilterGroup>;
|
|
3421
3572
|
};
|
|
@@ -3892,9 +4043,9 @@ type AnalyticsBreakdown = {
|
|
|
3892
4043
|
*/
|
|
3893
4044
|
name: string | null;
|
|
3894
4045
|
/**
|
|
3895
|
-
* 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).
|
|
4046
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
3896
4047
|
*/
|
|
3897
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
4048
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
3898
4049
|
/**
|
|
3899
4050
|
* Profile URL.
|
|
3900
4051
|
*/
|
|
@@ -4491,19 +4642,59 @@ type ListKeywordsData = {
|
|
|
4491
4642
|
/**
|
|
4492
4643
|
* Only keywords in any of these groups (grp_...). Repeatable, or comma-separated.
|
|
4493
4644
|
*/
|
|
4494
|
-
|
|
4645
|
+
groupIds?: Array<string> | null;
|
|
4646
|
+
/**
|
|
4647
|
+
* Never keywords in these groups (grp_...). Repeatable, or comma-separated.
|
|
4648
|
+
*/
|
|
4649
|
+
notGroupIds?: Array<string> | null;
|
|
4495
4650
|
/**
|
|
4496
4651
|
* Only these kinds: brand, competitor, topic. Repeatable, or comma-separated.
|
|
4497
4652
|
*/
|
|
4653
|
+
kinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
4654
|
+
/**
|
|
4655
|
+
* Never these kinds. Repeatable, or comma-separated.
|
|
4656
|
+
*/
|
|
4657
|
+
notKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
4658
|
+
/**
|
|
4659
|
+
* Never keywords in these states. Repeatable, or comma-separated.
|
|
4660
|
+
*/
|
|
4661
|
+
notStatuses?: Array<'active' | 'muted' | 'paused' | 'noisy' | 'capped'>;
|
|
4662
|
+
/**
|
|
4663
|
+
* Never keywords tracked on any of these platforms (by the same reading as platforms). Repeatable, or comma-separated.
|
|
4664
|
+
*/
|
|
4665
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4666
|
+
/**
|
|
4667
|
+
* Only keywords in these states: active, muted, paused, noisy, capped. Repeatable, or comma-separated.
|
|
4668
|
+
*/
|
|
4669
|
+
statuses?: Array<'active' | 'muted' | 'paused' | 'noisy' | 'capped'>;
|
|
4670
|
+
/**
|
|
4671
|
+
* 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.
|
|
4672
|
+
*/
|
|
4673
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4674
|
+
/**
|
|
4675
|
+
* Deprecated: use groupIds, the same filter; both are read as one list.
|
|
4676
|
+
*
|
|
4677
|
+
* @deprecated
|
|
4678
|
+
*/
|
|
4679
|
+
groupId?: Array<string> | null;
|
|
4680
|
+
/**
|
|
4681
|
+
* Deprecated: use kinds, the same filter; both are read as one list.
|
|
4682
|
+
*
|
|
4683
|
+
* @deprecated
|
|
4684
|
+
*/
|
|
4498
4685
|
kind?: Array<'brand' | 'competitor' | 'topic'>;
|
|
4499
4686
|
/**
|
|
4500
|
-
*
|
|
4687
|
+
* Deprecated: use statuses, the same filter; both are read as one list.
|
|
4688
|
+
*
|
|
4689
|
+
* @deprecated
|
|
4501
4690
|
*/
|
|
4502
4691
|
status?: Array<'active' | 'muted' | 'paused' | 'noisy' | 'capped'>;
|
|
4503
4692
|
/**
|
|
4504
|
-
*
|
|
4693
|
+
* Deprecated: use platforms, the same filter; both are read as one list.
|
|
4694
|
+
*
|
|
4695
|
+
* @deprecated
|
|
4505
4696
|
*/
|
|
4506
|
-
platform?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4697
|
+
platform?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
4507
4698
|
/**
|
|
4508
4699
|
* 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.
|
|
4509
4700
|
*/
|
|
@@ -4551,7 +4742,7 @@ type ListKeywordsResponses = {
|
|
|
4551
4742
|
*/
|
|
4552
4743
|
pausedForBalance: boolean;
|
|
4553
4744
|
/**
|
|
4554
|
-
* Muted by the noise brake:
|
|
4745
|
+
* Muted by the noise brake: under 30% of 20 or more scored matches were relevant, on welcome credit. Changing its rules, platforms or context, or unmuting, resumes it (balance permitting); a top-up does not. See [Billing](/billing).
|
|
4555
4746
|
*/
|
|
4556
4747
|
pausedForNoise: boolean;
|
|
4557
4748
|
/**
|
|
@@ -4567,7 +4758,7 @@ type ListKeywordsResponses = {
|
|
|
4567
4758
|
*/
|
|
4568
4759
|
mentions: number;
|
|
4569
4760
|
/**
|
|
4570
|
-
* The period the cap counts in, in UTC: day
|
|
4761
|
+
* The period the cap counts in, in UTC: day, week (from Monday) or calendar month (the default). At the cap the keyword stops until the next period starts.
|
|
4571
4762
|
*/
|
|
4572
4763
|
per?: 'day' | 'week' | 'month';
|
|
4573
4764
|
/**
|
|
@@ -4592,45 +4783,45 @@ type ListKeywordsResponses = {
|
|
|
4592
4783
|
resumesAt: string | null;
|
|
4593
4784
|
} | null;
|
|
4594
4785
|
/**
|
|
4595
|
-
* Comments under this keyword's mentions
|
|
4786
|
+
* Comments under this keyword's relevant mentions, read several times per thread on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments; see [Comments](/guides/comments).
|
|
4596
4787
|
*/
|
|
4597
4788
|
comments: {
|
|
4598
4789
|
/**
|
|
4599
|
-
* Read the comments under this keyword's relevant mentions
|
|
4790
|
+
* Read the comments under this keyword's relevant mentions. Each comment delivered costs $0.008; comments under three words are dropped, never billed. See [Comments](/guides/comments).
|
|
4600
4791
|
*/
|
|
4601
4792
|
enabled: boolean;
|
|
4602
4793
|
/**
|
|
4603
|
-
* The newest comments of one thread you receive
|
|
4794
|
+
* The newest comments of one thread you receive: the ceiling on what one mention's comments can cost. A comment naming the keyword is a mention only among these.
|
|
4604
4795
|
*/
|
|
4605
4796
|
maxPerPost: number;
|
|
4606
4797
|
};
|
|
4607
4798
|
/**
|
|
4608
|
-
* Which of this keyword's mentions you see, by language and country.
|
|
4799
|
+
* Which of this keyword's mentions you see, by language and country. A hidden post is still matched, classified and billed, but kept out of lists, exports, search, alerts and digests (includeHidden=true shows it). See [Keywords](/guides/keywords#show-only-some-languages-or-countries).
|
|
4609
4800
|
*/
|
|
4610
4801
|
display: {
|
|
4611
4802
|
/**
|
|
4612
|
-
* By the language the post is written in.
|
|
4803
|
+
* By the language the post is written in (ISO 639-1).
|
|
4613
4804
|
*/
|
|
4614
4805
|
languages: {
|
|
4615
4806
|
/**
|
|
4616
|
-
* When non-empty, a post whose language
|
|
4807
|
+
* When non-empty, a post whose language is known and not listed is hidden, one the classifier cannot name included. A post whose language nobody could tell is always shown.
|
|
4617
4808
|
*/
|
|
4618
4809
|
only: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
4619
4810
|
/**
|
|
4620
|
-
* A post whose language
|
|
4811
|
+
* A post whose language is listed is hidden.
|
|
4621
4812
|
*/
|
|
4622
4813
|
excluded: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
4623
4814
|
};
|
|
4624
4815
|
/**
|
|
4625
|
-
* By where the author is, as the classifier read their profile and the post.
|
|
4816
|
+
* By where the author is (ISO 3166-1 alpha-2), as the classifier read their profile and the post.
|
|
4626
4817
|
*/
|
|
4627
4818
|
countries: {
|
|
4628
4819
|
/**
|
|
4629
|
-
* When non-empty, a post whose author's country
|
|
4820
|
+
* When non-empty, a post whose author's country is known and not listed is hidden, one the classifier cannot name included. A post whose author's country nobody could tell is always shown.
|
|
4630
4821
|
*/
|
|
4631
4822
|
only: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
4632
4823
|
/**
|
|
4633
|
-
* A post whose author's country
|
|
4824
|
+
* A post whose author's country is listed is hidden.
|
|
4634
4825
|
*/
|
|
4635
4826
|
excluded: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
4636
4827
|
};
|
|
@@ -4639,7 +4830,7 @@ type ListKeywordsResponses = {
|
|
|
4639
4830
|
/**
|
|
4640
4831
|
* Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
|
|
4641
4832
|
*/
|
|
4642
|
-
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
4833
|
+
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook'> | null;
|
|
4643
4834
|
/**
|
|
4644
4835
|
* RSS and Atom feeds this keyword reads; empty for none.
|
|
4645
4836
|
*/
|
|
@@ -4653,7 +4844,7 @@ type ListKeywordsResponses = {
|
|
|
4653
4844
|
*/
|
|
4654
4845
|
reviewSources: Array<ReviewSource>;
|
|
4655
4846
|
/**
|
|
4656
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile or
|
|
4847
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or group description: what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
4657
4848
|
*/
|
|
4658
4849
|
context: string | null;
|
|
4659
4850
|
/**
|
|
@@ -4669,7 +4860,7 @@ type ListKeywordsResponses = {
|
|
|
4669
4860
|
*/
|
|
4670
4861
|
requiredMode: 'any' | 'all';
|
|
4671
4862
|
/**
|
|
4672
|
-
* Combinations
|
|
4863
|
+
* Combinations: the post must ALSO contain every term of at least one group (an OR of ANDs), on top of requiredTerms, with the same phrase and wildcard rules. See [Keywords](/guides/keywords#several-searches-in-one-keyword).
|
|
4673
4864
|
*/
|
|
4674
4865
|
requiredGroups: Array<Array<string>>;
|
|
4675
4866
|
/**
|
|
@@ -4685,7 +4876,7 @@ type ListKeywordsResponses = {
|
|
|
4685
4876
|
*/
|
|
4686
4877
|
caseSensitive: boolean;
|
|
4687
4878
|
/**
|
|
4688
|
-
* true: only the exact phrase matches. false
|
|
4879
|
+
* true: only the exact phrase matches (a term sent in double quotes sets it). false: a multi-word keyword also matches its words close together, kept and billed only when scored relevant. See [Keywords](/guides/keywords#the-exact-phrase-only).
|
|
4689
4880
|
*/
|
|
4690
4881
|
exactPhrase: boolean;
|
|
4691
4882
|
/**
|
|
@@ -4706,7 +4897,12 @@ type ListKeywordsResponses = {
|
|
|
4706
4897
|
*/
|
|
4707
4898
|
repositories: {
|
|
4708
4899
|
/**
|
|
4709
|
-
* The repository events this keyword takes
|
|
4900
|
+
* The repository events this keyword takes (default traction, stars, growth; empty: none). See [GitHub](/platforms/github#repositories).
|
|
4901
|
+
*
|
|
4902
|
+
* - traction: under 30 days old, it reached 10 stars.
|
|
4903
|
+
* - stars: it passed a milestone (100, 250, 500, 1,000 ...).
|
|
4904
|
+
* - growth: it gained stars fast in a week.
|
|
4905
|
+
* - new: every repository created; opt in, mostly noise.
|
|
4710
4906
|
*/
|
|
4711
4907
|
events: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
4712
4908
|
/**
|
|
@@ -4714,7 +4910,7 @@ type ListKeywordsResponses = {
|
|
|
4714
4910
|
*/
|
|
4715
4911
|
minStars: number | null;
|
|
4716
4912
|
/**
|
|
4717
|
-
* Only repositories that gained at least this many stars in the last 7 days
|
|
4913
|
+
* Only repositories that gained at least this many stars in the last 7 days, for every event; an unknown week fails. null: growth needs 100 stars and 20% a week, other events nothing.
|
|
4718
4914
|
*/
|
|
4719
4915
|
minWeeklyStars: number | null;
|
|
4720
4916
|
};
|
|
@@ -4774,11 +4970,18 @@ type ListKeywordsResponses = {
|
|
|
4774
4970
|
noisy: boolean;
|
|
4775
4971
|
};
|
|
4776
4972
|
/**
|
|
4777
|
-
* The
|
|
4973
|
+
* The first status that applies over the last 14 days; see [Keyword health](/guides/keyword-health).
|
|
4974
|
+
*
|
|
4975
|
+
* - paused: muted.
|
|
4976
|
+
* - capped: at its mention cap.
|
|
4977
|
+
* - noisy: 20 or more scored matches, under 30% relevant.
|
|
4978
|
+
* - new: under 7 days old, or changed lately with few scored matches.
|
|
4979
|
+
* - quiet: 7 days or older, nothing relevant.
|
|
4980
|
+
* - healthy: none of the above.
|
|
4778
4981
|
*/
|
|
4779
4982
|
health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
|
|
4780
4983
|
/**
|
|
4781
|
-
* What this keyword has cost this calendar month (UTC) at list price:
|
|
4984
|
+
* What this keyword has cost this calendar month (UTC) at list price: its row in GET /v1/usage/breakdown?month=<this month>. The ledger differs only by cumulative rounding.
|
|
4782
4985
|
*/
|
|
4783
4986
|
cost: {
|
|
4784
4987
|
/**
|
|
@@ -4816,9 +5019,9 @@ type ListKeywordsResponses = {
|
|
|
4816
5019
|
*/
|
|
4817
5020
|
polling: Array<{
|
|
4818
5021
|
/**
|
|
4819
|
-
* 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).
|
|
5022
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
4820
5023
|
*/
|
|
4821
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
5024
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
4822
5025
|
/**
|
|
4823
5026
|
* Newest poll of this platform for the term; null until the first one.
|
|
4824
5027
|
*/
|
|
@@ -4853,9 +5056,9 @@ type CreateKeywordData = {
|
|
|
4853
5056
|
/**
|
|
4854
5057
|
* 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.
|
|
4855
5058
|
*/
|
|
4856
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
5059
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook'> | null;
|
|
4857
5060
|
/**
|
|
4858
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile or
|
|
5061
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or group description: what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
4859
5062
|
*/
|
|
4860
5063
|
context?: string | null;
|
|
4861
5064
|
/**
|
|
@@ -4871,7 +5074,7 @@ type CreateKeywordData = {
|
|
|
4871
5074
|
*/
|
|
4872
5075
|
requiredMode?: 'any' | 'all';
|
|
4873
5076
|
/**
|
|
4874
|
-
* Combinations
|
|
5077
|
+
* Combinations: the post must ALSO contain every term of at least one group (an OR of ANDs), on top of requiredTerms, with the same phrase and wildcard rules. See [Keywords](/guides/keywords#several-searches-in-one-keyword).
|
|
4875
5078
|
*/
|
|
4876
5079
|
requiredGroups?: Array<Array<string>>;
|
|
4877
5080
|
/**
|
|
@@ -4887,7 +5090,7 @@ type CreateKeywordData = {
|
|
|
4887
5090
|
*/
|
|
4888
5091
|
caseSensitive?: boolean;
|
|
4889
5092
|
/**
|
|
4890
|
-
* true: only the exact phrase matches. false
|
|
5093
|
+
* true: only the exact phrase matches (a term sent in double quotes sets it). false: a multi-word keyword also matches its words close together, kept and billed only when scored relevant. See [Keywords](/guides/keywords#the-exact-phrase-only).
|
|
4891
5094
|
*/
|
|
4892
5095
|
exactPhrase?: boolean;
|
|
4893
5096
|
/**
|
|
@@ -4895,7 +5098,12 @@ type CreateKeywordData = {
|
|
|
4895
5098
|
*/
|
|
4896
5099
|
repositories?: {
|
|
4897
5100
|
/**
|
|
4898
|
-
* The repository events this keyword takes
|
|
5101
|
+
* The repository events this keyword takes (default traction, stars, growth; empty: none). See [GitHub](/platforms/github#repositories).
|
|
5102
|
+
*
|
|
5103
|
+
* - traction: under 30 days old, it reached 10 stars.
|
|
5104
|
+
* - stars: it passed a milestone (100, 250, 500, 1,000 ...).
|
|
5105
|
+
* - growth: it gained stars fast in a week.
|
|
5106
|
+
* - new: every repository created; opt in, mostly noise.
|
|
4899
5107
|
*/
|
|
4900
5108
|
events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
4901
5109
|
/**
|
|
@@ -4903,7 +5111,7 @@ type CreateKeywordData = {
|
|
|
4903
5111
|
*/
|
|
4904
5112
|
minStars?: number | null;
|
|
4905
5113
|
/**
|
|
4906
|
-
* Only repositories that gained at least this many stars in the last 7 days
|
|
5114
|
+
* Only repositories that gained at least this many stars in the last 7 days, for every event; an unknown week fails. null: growth needs 100 stars and 20% a week, other events nothing.
|
|
4907
5115
|
*/
|
|
4908
5116
|
minWeeklyStars?: number | null;
|
|
4909
5117
|
};
|
|
@@ -4930,7 +5138,7 @@ type CreateKeywordData = {
|
|
|
4930
5138
|
*/
|
|
4931
5139
|
mentions: number;
|
|
4932
5140
|
/**
|
|
4933
|
-
* The period the cap counts in, in UTC: day
|
|
5141
|
+
* The period the cap counts in, in UTC: day, week (from Monday) or calendar month (the default). At the cap the keyword stops until the next period starts.
|
|
4934
5142
|
*/
|
|
4935
5143
|
per?: 'day' | 'week' | 'month';
|
|
4936
5144
|
} | null;
|
|
@@ -4939,11 +5147,11 @@ type CreateKeywordData = {
|
|
|
4939
5147
|
*/
|
|
4940
5148
|
comments?: {
|
|
4941
5149
|
/**
|
|
4942
|
-
* Read the comments under this keyword's relevant mentions
|
|
5150
|
+
* Read the comments under this keyword's relevant mentions. Each comment delivered costs $0.008; comments under three words are dropped, never billed. See [Comments](/guides/comments).
|
|
4943
5151
|
*/
|
|
4944
5152
|
enabled?: boolean;
|
|
4945
5153
|
/**
|
|
4946
|
-
* The newest comments of one thread you receive
|
|
5154
|
+
* The newest comments of one thread you receive: the ceiling on what one mention's comments can cost. A comment naming the keyword is a mention only among these.
|
|
4947
5155
|
*/
|
|
4948
5156
|
maxPerPost?: number;
|
|
4949
5157
|
};
|
|
@@ -4983,7 +5191,7 @@ type CreateKeywordData = {
|
|
|
4983
5191
|
*/
|
|
4984
5192
|
groupId?: string;
|
|
4985
5193
|
/**
|
|
4986
|
-
* Review pages this keyword collects
|
|
5194
|
+
* Review pages this keyword collects (app store apps, Trustpilot pages, Google Maps places): every new review is a mention, whatever it says. Polled daily; a newly connected page brings 30 days back, free. See [Reviews](/platforms/reviews).
|
|
4987
5195
|
*/
|
|
4988
5196
|
reviewSources?: Array<{
|
|
4989
5197
|
/**
|
|
@@ -4999,7 +5207,7 @@ type CreateKeywordData = {
|
|
|
4999
5207
|
*/
|
|
5000
5208
|
id?: string;
|
|
5001
5209
|
/**
|
|
5002
|
-
* App Store and Google Play
|
|
5210
|
+
* App Store and Google Play storefronts to read, as two-letter codes; default the link's, else us. Each adds a daily poll; a review seen in two is one mention. Trustpilot and Google Maps take none.
|
|
5003
5211
|
*/
|
|
5004
5212
|
countries?: Array<string>;
|
|
5005
5213
|
/**
|
|
@@ -5008,7 +5216,7 @@ type CreateKeywordData = {
|
|
|
5008
5216
|
language?: string;
|
|
5009
5217
|
}>;
|
|
5010
5218
|
/**
|
|
5011
|
-
* RSS or Atom feeds this keyword reads
|
|
5219
|
+
* RSS or Atom feeds only this keyword reads: a feed's URL, or a page that advertises one (else a 400). Read hourly; an item holding the term is a mention. See [RSS](/platforms/rss#a-keywords-own-feeds).
|
|
5012
5220
|
*/
|
|
5013
5221
|
feeds?: Array<{
|
|
5014
5222
|
/**
|
|
@@ -5021,6 +5229,12 @@ type CreateKeywordData = {
|
|
|
5021
5229
|
*/
|
|
5022
5230
|
readsWorkspaceFeeds?: boolean;
|
|
5023
5231
|
};
|
|
5232
|
+
headers?: {
|
|
5233
|
+
/**
|
|
5234
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
5235
|
+
*/
|
|
5236
|
+
'idempotency-key'?: string;
|
|
5237
|
+
};
|
|
5024
5238
|
path?: never;
|
|
5025
5239
|
query?: never;
|
|
5026
5240
|
url: '/v1/keywords';
|
|
@@ -5111,7 +5325,7 @@ type UpdateKeywordData = {
|
|
|
5111
5325
|
*/
|
|
5112
5326
|
body: {
|
|
5113
5327
|
/**
|
|
5114
|
-
* Renames the keyword: the new term is tracked from now on, with no look-back,
|
|
5328
|
+
* Renames the keyword: the new term is tracked from now on, with no look-back, keeping its id, settings and old mentions. Double quotes mean the exact phrase only. 409 when its group already tracks it.
|
|
5115
5329
|
*/
|
|
5116
5330
|
term?: string;
|
|
5117
5331
|
/**
|
|
@@ -5125,9 +5339,9 @@ type UpdateKeywordData = {
|
|
|
5125
5339
|
/**
|
|
5126
5340
|
* Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).
|
|
5127
5341
|
*/
|
|
5128
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
|
|
5342
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook'> | null;
|
|
5129
5343
|
/**
|
|
5130
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile or
|
|
5344
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or group description: what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
5131
5345
|
*/
|
|
5132
5346
|
context?: string | null;
|
|
5133
5347
|
/**
|
|
@@ -5143,7 +5357,7 @@ type UpdateKeywordData = {
|
|
|
5143
5357
|
*/
|
|
5144
5358
|
requiredMode?: 'any' | 'all';
|
|
5145
5359
|
/**
|
|
5146
|
-
* Combinations
|
|
5360
|
+
* Combinations: the post must ALSO contain every term of at least one group (an OR of ANDs), on top of requiredTerms, with the same phrase and wildcard rules. See [Keywords](/guides/keywords#several-searches-in-one-keyword).
|
|
5147
5361
|
*/
|
|
5148
5362
|
requiredGroups?: Array<Array<string>>;
|
|
5149
5363
|
/**
|
|
@@ -5159,7 +5373,7 @@ type UpdateKeywordData = {
|
|
|
5159
5373
|
*/
|
|
5160
5374
|
caseSensitive?: boolean;
|
|
5161
5375
|
/**
|
|
5162
|
-
* true: only the exact phrase matches. false
|
|
5376
|
+
* true: only the exact phrase matches (a term sent in double quotes sets it). false: a multi-word keyword also matches its words close together, kept and billed only when scored relevant. See [Keywords](/guides/keywords#the-exact-phrase-only).
|
|
5163
5377
|
*/
|
|
5164
5378
|
exactPhrase?: boolean;
|
|
5165
5379
|
/**
|
|
@@ -5167,7 +5381,12 @@ type UpdateKeywordData = {
|
|
|
5167
5381
|
*/
|
|
5168
5382
|
repositories?: {
|
|
5169
5383
|
/**
|
|
5170
|
-
* The repository events this keyword takes
|
|
5384
|
+
* The repository events this keyword takes (default traction, stars, growth; empty: none). See [GitHub](/platforms/github#repositories).
|
|
5385
|
+
*
|
|
5386
|
+
* - traction: under 30 days old, it reached 10 stars.
|
|
5387
|
+
* - stars: it passed a milestone (100, 250, 500, 1,000 ...).
|
|
5388
|
+
* - growth: it gained stars fast in a week.
|
|
5389
|
+
* - new: every repository created; opt in, mostly noise.
|
|
5171
5390
|
*/
|
|
5172
5391
|
events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
|
|
5173
5392
|
/**
|
|
@@ -5175,7 +5394,7 @@ type UpdateKeywordData = {
|
|
|
5175
5394
|
*/
|
|
5176
5395
|
minStars?: number | null;
|
|
5177
5396
|
/**
|
|
5178
|
-
* Only repositories that gained at least this many stars in the last 7 days
|
|
5397
|
+
* Only repositories that gained at least this many stars in the last 7 days, for every event; an unknown week fails. null: growth needs 100 stars and 20% a week, other events nothing.
|
|
5179
5398
|
*/
|
|
5180
5399
|
minWeeklyStars?: number | null;
|
|
5181
5400
|
};
|
|
@@ -5202,7 +5421,7 @@ type UpdateKeywordData = {
|
|
|
5202
5421
|
*/
|
|
5203
5422
|
mentions: number;
|
|
5204
5423
|
/**
|
|
5205
|
-
* The period the cap counts in, in UTC: day
|
|
5424
|
+
* The period the cap counts in, in UTC: day, week (from Monday) or calendar month (the default). At the cap the keyword stops until the next period starts.
|
|
5206
5425
|
*/
|
|
5207
5426
|
per?: 'day' | 'week' | 'month';
|
|
5208
5427
|
} | null;
|
|
@@ -5211,11 +5430,11 @@ type UpdateKeywordData = {
|
|
|
5211
5430
|
*/
|
|
5212
5431
|
comments?: {
|
|
5213
5432
|
/**
|
|
5214
|
-
* Read the comments under this keyword's relevant mentions
|
|
5433
|
+
* Read the comments under this keyword's relevant mentions. Each comment delivered costs $0.008; comments under three words are dropped, never billed. See [Comments](/guides/comments).
|
|
5215
5434
|
*/
|
|
5216
5435
|
enabled?: boolean;
|
|
5217
5436
|
/**
|
|
5218
|
-
* The newest comments of one thread you receive
|
|
5437
|
+
* The newest comments of one thread you receive: the ceiling on what one mention's comments can cost. A comment naming the keyword is a mention only among these.
|
|
5219
5438
|
*/
|
|
5220
5439
|
maxPerPost?: number;
|
|
5221
5440
|
};
|
|
@@ -5271,7 +5490,7 @@ type UpdateKeywordData = {
|
|
|
5271
5490
|
*/
|
|
5272
5491
|
id?: string;
|
|
5273
5492
|
/**
|
|
5274
|
-
* App Store and Google Play
|
|
5493
|
+
* App Store and Google Play storefronts to read, as two-letter codes; default the link's, else us. Each adds a daily poll; a review seen in two is one mention. Trustpilot and Google Maps take none.
|
|
5275
5494
|
*/
|
|
5276
5495
|
countries?: Array<string>;
|
|
5277
5496
|
/**
|
|
@@ -5389,6 +5608,12 @@ type DuplicateKeywordData = {
|
|
|
5389
5608
|
*/
|
|
5390
5609
|
include?: Array<'reviewSources' | 'feeds'>;
|
|
5391
5610
|
};
|
|
5611
|
+
headers?: {
|
|
5612
|
+
/**
|
|
5613
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
5614
|
+
*/
|
|
5615
|
+
'idempotency-key'?: string;
|
|
5616
|
+
};
|
|
5392
5617
|
path: {
|
|
5393
5618
|
/**
|
|
5394
5619
|
* Keyword id (kw_...).
|
|
@@ -5476,7 +5701,7 @@ type ListFeedsResponses = {
|
|
|
5476
5701
|
*/
|
|
5477
5702
|
connectedAt: string;
|
|
5478
5703
|
/**
|
|
5479
|
-
* Nothing published before this is a live mention: the connection, or the last
|
|
5704
|
+
* Nothing published before this is a live mention: the connection, or the last sign-in change (signed in or out, a post reads as a new one, so it starts over rather than bill twice).
|
|
5480
5705
|
*/
|
|
5481
5706
|
readingSince: string;
|
|
5482
5707
|
/**
|
|
@@ -5564,6 +5789,12 @@ type CreateFeedData = {
|
|
|
5564
5789
|
value: string;
|
|
5565
5790
|
};
|
|
5566
5791
|
};
|
|
5792
|
+
headers?: {
|
|
5793
|
+
/**
|
|
5794
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
5795
|
+
*/
|
|
5796
|
+
'idempotency-key'?: string;
|
|
5797
|
+
};
|
|
5567
5798
|
path?: never;
|
|
5568
5799
|
query?: never;
|
|
5569
5800
|
url: '/v1/feeds';
|
|
@@ -5687,7 +5918,7 @@ type ImportFeedsResponses = {
|
|
|
5687
5918
|
*/
|
|
5688
5919
|
connectedAt: string;
|
|
5689
5920
|
/**
|
|
5690
|
-
* Nothing published before this is a live mention: the connection, or the last
|
|
5921
|
+
* Nothing published before this is a live mention: the connection, or the last sign-in change (signed in or out, a post reads as a new one, so it starts over rather than bill twice).
|
|
5691
5922
|
*/
|
|
5692
5923
|
readingSince: string;
|
|
5693
5924
|
/**
|
|
@@ -5743,7 +5974,7 @@ type ImportFeedsResponses = {
|
|
|
5743
5974
|
*/
|
|
5744
5975
|
error: {
|
|
5745
5976
|
/**
|
|
5746
|
-
* The
|
|
5977
|
+
* The code POST /v1/feeds answers for this address: feed_login_required (resend with auth), feed_login_expired (fresh cookie), feed_unreadable (no feed, or blocked), feed_limit_reached, feed_auth_not_configured, validation_error, internal_error (retry).
|
|
5747
5978
|
*/
|
|
5748
5979
|
code: 'feed_login_required' | 'feed_login_expired' | 'feed_unreadable' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'validation_error' | 'internal_error';
|
|
5749
5980
|
/**
|
|
@@ -6010,7 +6241,7 @@ type UpdateMentionData = {
|
|
|
6010
6241
|
*/
|
|
6011
6242
|
note?: string | null;
|
|
6012
6243
|
/**
|
|
6013
|
-
* Your verdict
|
|
6244
|
+
* Your verdict: true sets relevance to 100 (a filtered mention becomes relevant), false to 0; null restores the classifier's score. Billing never changes. 409 classification_pending while it is still being classified.
|
|
6014
6245
|
*/
|
|
6015
6246
|
relevant?: boolean | null;
|
|
6016
6247
|
/**
|
|
@@ -6058,13 +6289,17 @@ type SearchMentionsData = {
|
|
|
6058
6289
|
path?: never;
|
|
6059
6290
|
query?: {
|
|
6060
6291
|
/**
|
|
6061
|
-
* Only matches of this keyword.
|
|
6292
|
+
* Deprecated: use keywordIds. Only matches of this keyword; combines with keywordIds as either.
|
|
6293
|
+
*
|
|
6294
|
+
* @deprecated
|
|
6062
6295
|
*/
|
|
6063
6296
|
keywordId?: string;
|
|
6064
6297
|
/**
|
|
6065
|
-
* Only posts from this platform.
|
|
6298
|
+
* Deprecated: use platforms. Only posts from this platform; combines with platforms as either.
|
|
6299
|
+
*
|
|
6300
|
+
* @deprecated
|
|
6066
6301
|
*/
|
|
6067
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
6302
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
6068
6303
|
/**
|
|
6069
6304
|
* Only mentions in this status. Omit for every status.
|
|
6070
6305
|
*/
|
|
@@ -6074,11 +6309,15 @@ type SearchMentionsData = {
|
|
|
6074
6309
|
*/
|
|
6075
6310
|
relevant?: boolean;
|
|
6076
6311
|
/**
|
|
6077
|
-
* Only this sentiment.
|
|
6312
|
+
* Deprecated: use sentiments. Only this sentiment; combines with sentiments as either.
|
|
6313
|
+
*
|
|
6314
|
+
* @deprecated
|
|
6078
6315
|
*/
|
|
6079
6316
|
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
6080
6317
|
/**
|
|
6081
|
-
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
6318
|
+
* Deprecated: use intents. Only mentions carrying this intent or topic tag, combined with intents as either (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
6319
|
+
*
|
|
6320
|
+
* @deprecated
|
|
6082
6321
|
*/
|
|
6083
6322
|
intent?: string;
|
|
6084
6323
|
/**
|
|
@@ -6116,6 +6355,12 @@ type SearchMentionsData = {
|
|
|
6116
6355
|
/**
|
|
6117
6356
|
* Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
|
|
6118
6357
|
*/
|
|
6358
|
+
notAuthors?: Array<string> | null;
|
|
6359
|
+
/**
|
|
6360
|
+
* Deprecated: use notAuthors, the same filter. Both may be sent; every author named in either is hidden.
|
|
6361
|
+
*
|
|
6362
|
+
* @deprecated
|
|
6363
|
+
*/
|
|
6119
6364
|
excludeAuthors?: Array<string> | null;
|
|
6120
6365
|
/**
|
|
6121
6366
|
* Only mentions scored at least this; unclassified ones are excluded.
|
|
@@ -6164,11 +6409,11 @@ type SearchMentionsData = {
|
|
|
6164
6409
|
/**
|
|
6165
6410
|
* Only posts from any of these platforms.
|
|
6166
6411
|
*/
|
|
6167
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6412
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6168
6413
|
/**
|
|
6169
6414
|
* Never posts from these platforms.
|
|
6170
6415
|
*/
|
|
6171
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6416
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6172
6417
|
/**
|
|
6173
6418
|
* Only matches of any of these keywords.
|
|
6174
6419
|
*/
|
|
@@ -6266,7 +6511,7 @@ type SearchMentionsData = {
|
|
|
6266
6511
|
*/
|
|
6267
6512
|
minBookmarks?: number | null;
|
|
6268
6513
|
/**
|
|
6269
|
-
* OR across groups of conditions, as URL-encoded JSON:
|
|
6514
|
+
* OR across groups of conditions, as URL-encoded JSON: a mention passes when one group holds, on top of every other filter. Each group holds view-filter conditions, no nesting. See [anyOf](/conventions#or-across-groups-anyof).
|
|
6270
6515
|
*/
|
|
6271
6516
|
anyOf?: string;
|
|
6272
6517
|
/**
|
|
@@ -6274,11 +6519,31 @@ type SearchMentionsData = {
|
|
|
6274
6519
|
*/
|
|
6275
6520
|
q?: string;
|
|
6276
6521
|
/**
|
|
6277
|
-
*
|
|
6522
|
+
* A preset window ending now: 7d is today and the six days before, in `timezone`, as in the analytics reports. Ignored when from or to is given. Omit range, from and to for no window.
|
|
6523
|
+
*/
|
|
6524
|
+
range?: '7d' | '30d' | '90d' | '365d';
|
|
6525
|
+
/**
|
|
6526
|
+
* Start, inclusive: a day (YYYY-MM-DD, from its first moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
6527
|
+
*/
|
|
6528
|
+
from?: string;
|
|
6529
|
+
/**
|
|
6530
|
+
* End, inclusive: a day (YYYY-MM-DD, to its last moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
6531
|
+
*/
|
|
6532
|
+
to?: string;
|
|
6533
|
+
/**
|
|
6534
|
+
* IANA zone that days in range, from and to are cut in (Europe/Madrid). Default UTC.
|
|
6535
|
+
*/
|
|
6536
|
+
timezone?: string;
|
|
6537
|
+
/**
|
|
6538
|
+
* Deprecated: use from. Only posts published at or after this instant (ISO 8601, or epoch ms).
|
|
6539
|
+
*
|
|
6540
|
+
* @deprecated
|
|
6278
6541
|
*/
|
|
6279
6542
|
since?: string;
|
|
6280
6543
|
/**
|
|
6281
|
-
* Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
6544
|
+
* Deprecated: use to. Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
6545
|
+
*
|
|
6546
|
+
* @deprecated
|
|
6282
6547
|
*/
|
|
6283
6548
|
until?: string;
|
|
6284
6549
|
/**
|
|
@@ -6290,7 +6555,7 @@ type SearchMentionsData = {
|
|
|
6290
6555
|
*/
|
|
6291
6556
|
cursor?: string;
|
|
6292
6557
|
/**
|
|
6293
|
-
* Page size, 1 to 100.
|
|
6558
|
+
* Page size, 1 to 100 (default 50).
|
|
6294
6559
|
*/
|
|
6295
6560
|
limit?: number;
|
|
6296
6561
|
};
|
|
@@ -6325,13 +6590,17 @@ type ExportMentionsCsvData = {
|
|
|
6325
6590
|
path?: never;
|
|
6326
6591
|
query?: {
|
|
6327
6592
|
/**
|
|
6328
|
-
* Only matches of this keyword.
|
|
6593
|
+
* Deprecated: use keywordIds. Only matches of this keyword; combines with keywordIds as either.
|
|
6594
|
+
*
|
|
6595
|
+
* @deprecated
|
|
6329
6596
|
*/
|
|
6330
6597
|
keywordId?: string;
|
|
6331
6598
|
/**
|
|
6332
|
-
* Only posts from this platform.
|
|
6599
|
+
* Deprecated: use platforms. Only posts from this platform; combines with platforms as either.
|
|
6600
|
+
*
|
|
6601
|
+
* @deprecated
|
|
6333
6602
|
*/
|
|
6334
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
6603
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
6335
6604
|
/**
|
|
6336
6605
|
* Only mentions in this status. Omit for every status.
|
|
6337
6606
|
*/
|
|
@@ -6341,11 +6610,15 @@ type ExportMentionsCsvData = {
|
|
|
6341
6610
|
*/
|
|
6342
6611
|
relevant?: boolean;
|
|
6343
6612
|
/**
|
|
6344
|
-
* Only this sentiment.
|
|
6613
|
+
* Deprecated: use sentiments. Only this sentiment; combines with sentiments as either.
|
|
6614
|
+
*
|
|
6615
|
+
* @deprecated
|
|
6345
6616
|
*/
|
|
6346
6617
|
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
6347
6618
|
/**
|
|
6348
|
-
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
6619
|
+
* Deprecated: use intents. Only mentions carrying this intent or topic tag, combined with intents as either (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
6620
|
+
*
|
|
6621
|
+
* @deprecated
|
|
6349
6622
|
*/
|
|
6350
6623
|
intent?: string;
|
|
6351
6624
|
/**
|
|
@@ -6383,6 +6656,12 @@ type ExportMentionsCsvData = {
|
|
|
6383
6656
|
/**
|
|
6384
6657
|
* Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
|
|
6385
6658
|
*/
|
|
6659
|
+
notAuthors?: Array<string> | null;
|
|
6660
|
+
/**
|
|
6661
|
+
* Deprecated: use notAuthors, the same filter. Both may be sent; every author named in either is hidden.
|
|
6662
|
+
*
|
|
6663
|
+
* @deprecated
|
|
6664
|
+
*/
|
|
6386
6665
|
excludeAuthors?: Array<string> | null;
|
|
6387
6666
|
/**
|
|
6388
6667
|
* Only mentions scored at least this; unclassified ones are excluded.
|
|
@@ -6431,11 +6710,11 @@ type ExportMentionsCsvData = {
|
|
|
6431
6710
|
/**
|
|
6432
6711
|
* Only posts from any of these platforms.
|
|
6433
6712
|
*/
|
|
6434
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6713
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6435
6714
|
/**
|
|
6436
6715
|
* Never posts from these platforms.
|
|
6437
6716
|
*/
|
|
6438
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6717
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6439
6718
|
/**
|
|
6440
6719
|
* Only matches of any of these keywords.
|
|
6441
6720
|
*/
|
|
@@ -6533,7 +6812,7 @@ type ExportMentionsCsvData = {
|
|
|
6533
6812
|
*/
|
|
6534
6813
|
minBookmarks?: number | null;
|
|
6535
6814
|
/**
|
|
6536
|
-
* OR across groups of conditions, as URL-encoded JSON:
|
|
6815
|
+
* OR across groups of conditions, as URL-encoded JSON: a mention passes when one group holds, on top of every other filter. Each group holds view-filter conditions, no nesting. See [anyOf](/conventions#or-across-groups-anyof).
|
|
6537
6816
|
*/
|
|
6538
6817
|
anyOf?: string;
|
|
6539
6818
|
/**
|
|
@@ -6541,11 +6820,31 @@ type ExportMentionsCsvData = {
|
|
|
6541
6820
|
*/
|
|
6542
6821
|
q?: string;
|
|
6543
6822
|
/**
|
|
6544
|
-
*
|
|
6823
|
+
* A preset window ending now: 7d is today and the six days before, in `timezone`, as in the analytics reports. Ignored when from or to is given. Omit range, from and to for no window.
|
|
6824
|
+
*/
|
|
6825
|
+
range?: '7d' | '30d' | '90d' | '365d';
|
|
6826
|
+
/**
|
|
6827
|
+
* Start, inclusive: a day (YYYY-MM-DD, from its first moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
6828
|
+
*/
|
|
6829
|
+
from?: string;
|
|
6830
|
+
/**
|
|
6831
|
+
* End, inclusive: a day (YYYY-MM-DD, to its last moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
6832
|
+
*/
|
|
6833
|
+
to?: string;
|
|
6834
|
+
/**
|
|
6835
|
+
* IANA zone that days in range, from and to are cut in (Europe/Madrid). Default UTC.
|
|
6836
|
+
*/
|
|
6837
|
+
timezone?: string;
|
|
6838
|
+
/**
|
|
6839
|
+
* Deprecated: use from. Only posts published at or after this instant (ISO 8601, or epoch ms).
|
|
6840
|
+
*
|
|
6841
|
+
* @deprecated
|
|
6545
6842
|
*/
|
|
6546
6843
|
since?: string;
|
|
6547
6844
|
/**
|
|
6548
|
-
* Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
6845
|
+
* Deprecated: use to. Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
6846
|
+
*
|
|
6847
|
+
* @deprecated
|
|
6549
6848
|
*/
|
|
6550
6849
|
until?: string;
|
|
6551
6850
|
};
|
|
@@ -6626,13 +6925,17 @@ type ExportMentionsJsonData = {
|
|
|
6626
6925
|
path?: never;
|
|
6627
6926
|
query?: {
|
|
6628
6927
|
/**
|
|
6629
|
-
* Only matches of this keyword.
|
|
6928
|
+
* Deprecated: use keywordIds. Only matches of this keyword; combines with keywordIds as either.
|
|
6929
|
+
*
|
|
6930
|
+
* @deprecated
|
|
6630
6931
|
*/
|
|
6631
6932
|
keywordId?: string;
|
|
6632
6933
|
/**
|
|
6633
|
-
* Only posts from this platform.
|
|
6934
|
+
* Deprecated: use platforms. Only posts from this platform; combines with platforms as either.
|
|
6935
|
+
*
|
|
6936
|
+
* @deprecated
|
|
6634
6937
|
*/
|
|
6635
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
6938
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
6636
6939
|
/**
|
|
6637
6940
|
* Only mentions in this status. Omit for every status.
|
|
6638
6941
|
*/
|
|
@@ -6642,11 +6945,15 @@ type ExportMentionsJsonData = {
|
|
|
6642
6945
|
*/
|
|
6643
6946
|
relevant?: boolean;
|
|
6644
6947
|
/**
|
|
6645
|
-
* Only this sentiment.
|
|
6948
|
+
* Deprecated: use sentiments. Only this sentiment; combines with sentiments as either.
|
|
6949
|
+
*
|
|
6950
|
+
* @deprecated
|
|
6646
6951
|
*/
|
|
6647
6952
|
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
6648
6953
|
/**
|
|
6649
|
-
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
6954
|
+
* Deprecated: use intents. Only mentions carrying this intent or topic tag, combined with intents as either (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
6955
|
+
*
|
|
6956
|
+
* @deprecated
|
|
6650
6957
|
*/
|
|
6651
6958
|
intent?: string;
|
|
6652
6959
|
/**
|
|
@@ -6684,6 +6991,12 @@ type ExportMentionsJsonData = {
|
|
|
6684
6991
|
/**
|
|
6685
6992
|
* Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
|
|
6686
6993
|
*/
|
|
6994
|
+
notAuthors?: Array<string> | null;
|
|
6995
|
+
/**
|
|
6996
|
+
* Deprecated: use notAuthors, the same filter. Both may be sent; every author named in either is hidden.
|
|
6997
|
+
*
|
|
6998
|
+
* @deprecated
|
|
6999
|
+
*/
|
|
6687
7000
|
excludeAuthors?: Array<string> | null;
|
|
6688
7001
|
/**
|
|
6689
7002
|
* Only mentions scored at least this; unclassified ones are excluded.
|
|
@@ -6732,11 +7045,11 @@ type ExportMentionsJsonData = {
|
|
|
6732
7045
|
/**
|
|
6733
7046
|
* Only posts from any of these platforms.
|
|
6734
7047
|
*/
|
|
6735
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7048
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6736
7049
|
/**
|
|
6737
7050
|
* Never posts from these platforms.
|
|
6738
7051
|
*/
|
|
6739
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7052
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6740
7053
|
/**
|
|
6741
7054
|
* Only matches of any of these keywords.
|
|
6742
7055
|
*/
|
|
@@ -6834,7 +7147,7 @@ type ExportMentionsJsonData = {
|
|
|
6834
7147
|
*/
|
|
6835
7148
|
minBookmarks?: number | null;
|
|
6836
7149
|
/**
|
|
6837
|
-
* OR across groups of conditions, as URL-encoded JSON:
|
|
7150
|
+
* OR across groups of conditions, as URL-encoded JSON: a mention passes when one group holds, on top of every other filter. Each group holds view-filter conditions, no nesting. See [anyOf](/conventions#or-across-groups-anyof).
|
|
6838
7151
|
*/
|
|
6839
7152
|
anyOf?: string;
|
|
6840
7153
|
/**
|
|
@@ -6842,11 +7155,31 @@ type ExportMentionsJsonData = {
|
|
|
6842
7155
|
*/
|
|
6843
7156
|
q?: string;
|
|
6844
7157
|
/**
|
|
6845
|
-
*
|
|
7158
|
+
* A preset window ending now: 7d is today and the six days before, in `timezone`, as in the analytics reports. Ignored when from or to is given. Omit range, from and to for no window.
|
|
7159
|
+
*/
|
|
7160
|
+
range?: '7d' | '30d' | '90d' | '365d';
|
|
7161
|
+
/**
|
|
7162
|
+
* Start, inclusive: a day (YYYY-MM-DD, from its first moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
7163
|
+
*/
|
|
7164
|
+
from?: string;
|
|
7165
|
+
/**
|
|
7166
|
+
* End, inclusive: a day (YYYY-MM-DD, to its last moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
7167
|
+
*/
|
|
7168
|
+
to?: string;
|
|
7169
|
+
/**
|
|
7170
|
+
* IANA zone that days in range, from and to are cut in (Europe/Madrid). Default UTC.
|
|
7171
|
+
*/
|
|
7172
|
+
timezone?: string;
|
|
7173
|
+
/**
|
|
7174
|
+
* Deprecated: use from. Only posts published at or after this instant (ISO 8601, or epoch ms).
|
|
7175
|
+
*
|
|
7176
|
+
* @deprecated
|
|
6846
7177
|
*/
|
|
6847
7178
|
since?: string;
|
|
6848
7179
|
/**
|
|
6849
|
-
* Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
7180
|
+
* Deprecated: use to. Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
7181
|
+
*
|
|
7182
|
+
* @deprecated
|
|
6850
7183
|
*/
|
|
6851
7184
|
until?: string;
|
|
6852
7185
|
};
|
|
@@ -6892,9 +7225,11 @@ type ExportPeopleCsvData = {
|
|
|
6892
7225
|
*/
|
|
6893
7226
|
groupId?: string;
|
|
6894
7227
|
/**
|
|
6895
|
-
* People with an account on this platform.
|
|
7228
|
+
* Deprecated: use platforms. People with an account on this platform; combines with platforms as either.
|
|
7229
|
+
*
|
|
7230
|
+
* @deprecated
|
|
6896
7231
|
*/
|
|
6897
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
7232
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
6898
7233
|
/**
|
|
6899
7234
|
* Matches the display name or the profile handle or URL, case-insensitively.
|
|
6900
7235
|
*/
|
|
@@ -6904,7 +7239,9 @@ type ExportPeopleCsvData = {
|
|
|
6904
7239
|
*/
|
|
6905
7240
|
handle?: string;
|
|
6906
7241
|
/**
|
|
6907
|
-
* Only people carrying this tag (exact, case-sensitive).
|
|
7242
|
+
* Deprecated: use tags. Only people carrying this tag (exact, case-sensitive); combines with tags as either.
|
|
7243
|
+
*
|
|
7244
|
+
* @deprecated
|
|
6908
7245
|
*/
|
|
6909
7246
|
tag?: string;
|
|
6910
7247
|
/**
|
|
@@ -6912,7 +7249,25 @@ type ExportPeopleCsvData = {
|
|
|
6912
7249
|
*/
|
|
6913
7250
|
muted?: boolean;
|
|
6914
7251
|
/**
|
|
6915
|
-
*
|
|
7252
|
+
* A preset window ending now: 7d is today and the six days before, in `timezone`, as in the analytics reports. Ignored when from or to is given. Omit range, from and to for no window.
|
|
7253
|
+
*/
|
|
7254
|
+
range?: '7d' | '30d' | '90d' | '365d';
|
|
7255
|
+
/**
|
|
7256
|
+
* Start, inclusive: a day (YYYY-MM-DD, from its first moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
7257
|
+
*/
|
|
7258
|
+
from?: string;
|
|
7259
|
+
/**
|
|
7260
|
+
* End, inclusive: a day (YYYY-MM-DD, to its last moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
7261
|
+
*/
|
|
7262
|
+
to?: string;
|
|
7263
|
+
/**
|
|
7264
|
+
* IANA zone that days in range, from and to are cut in (Europe/Madrid). Default UTC.
|
|
7265
|
+
*/
|
|
7266
|
+
timezone?: string;
|
|
7267
|
+
/**
|
|
7268
|
+
* Deprecated: use from. Only people whose first matched mention is at or after this instant (ISO 8601, or epoch ms).
|
|
7269
|
+
*
|
|
7270
|
+
* @deprecated
|
|
6916
7271
|
*/
|
|
6917
7272
|
since?: string;
|
|
6918
7273
|
/**
|
|
@@ -6922,7 +7277,7 @@ type ExportPeopleCsvData = {
|
|
|
6922
7277
|
/**
|
|
6923
7278
|
* People with an account on any of these platforms. Repeatable, or comma-separated.
|
|
6924
7279
|
*/
|
|
6925
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7280
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6926
7281
|
/**
|
|
6927
7282
|
* People carrying any of these tags. Repeatable, or comma-separated.
|
|
6928
7283
|
*/
|
|
@@ -6950,7 +7305,7 @@ type ExportPeopleCsvData = {
|
|
|
6950
7305
|
/**
|
|
6951
7306
|
* Nobody with an account on these platforms. Repeatable, or comma-separated.
|
|
6952
7307
|
*/
|
|
6953
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7308
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
6954
7309
|
/**
|
|
6955
7310
|
* Nobody carrying any of these tags. Repeatable, or comma-separated.
|
|
6956
7311
|
*/
|
|
@@ -7029,9 +7384,11 @@ type ListPeopleData = {
|
|
|
7029
7384
|
*/
|
|
7030
7385
|
groupId?: string;
|
|
7031
7386
|
/**
|
|
7032
|
-
* People with an account on this platform.
|
|
7387
|
+
* Deprecated: use platforms. People with an account on this platform; combines with platforms as either.
|
|
7388
|
+
*
|
|
7389
|
+
* @deprecated
|
|
7033
7390
|
*/
|
|
7034
|
-
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
7391
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
7035
7392
|
/**
|
|
7036
7393
|
* Matches the display name or the profile handle or URL, case-insensitively.
|
|
7037
7394
|
*/
|
|
@@ -7041,7 +7398,9 @@ type ListPeopleData = {
|
|
|
7041
7398
|
*/
|
|
7042
7399
|
handle?: string;
|
|
7043
7400
|
/**
|
|
7044
|
-
* Only people carrying this tag (exact, case-sensitive).
|
|
7401
|
+
* Deprecated: use tags. Only people carrying this tag (exact, case-sensitive); combines with tags as either.
|
|
7402
|
+
*
|
|
7403
|
+
* @deprecated
|
|
7045
7404
|
*/
|
|
7046
7405
|
tag?: string;
|
|
7047
7406
|
/**
|
|
@@ -7049,7 +7408,25 @@ type ListPeopleData = {
|
|
|
7049
7408
|
*/
|
|
7050
7409
|
muted?: boolean;
|
|
7051
7410
|
/**
|
|
7052
|
-
*
|
|
7411
|
+
* A preset window ending now: 7d is today and the six days before, in `timezone`, as in the analytics reports. Ignored when from or to is given. Omit range, from and to for no window.
|
|
7412
|
+
*/
|
|
7413
|
+
range?: '7d' | '30d' | '90d' | '365d';
|
|
7414
|
+
/**
|
|
7415
|
+
* Start, inclusive: a day (YYYY-MM-DD, from its first moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
7416
|
+
*/
|
|
7417
|
+
from?: string;
|
|
7418
|
+
/**
|
|
7419
|
+
* End, inclusive: a day (YYYY-MM-DD, to its last moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
|
|
7420
|
+
*/
|
|
7421
|
+
to?: string;
|
|
7422
|
+
/**
|
|
7423
|
+
* IANA zone that days in range, from and to are cut in (Europe/Madrid). Default UTC.
|
|
7424
|
+
*/
|
|
7425
|
+
timezone?: string;
|
|
7426
|
+
/**
|
|
7427
|
+
* Deprecated: use from. Only people whose first matched mention is at or after this instant (ISO 8601, or epoch ms).
|
|
7428
|
+
*
|
|
7429
|
+
* @deprecated
|
|
7053
7430
|
*/
|
|
7054
7431
|
since?: string;
|
|
7055
7432
|
/**
|
|
@@ -7059,7 +7436,7 @@ type ListPeopleData = {
|
|
|
7059
7436
|
/**
|
|
7060
7437
|
* People with an account on any of these platforms. Repeatable, or comma-separated.
|
|
7061
7438
|
*/
|
|
7062
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7439
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7063
7440
|
/**
|
|
7064
7441
|
* People carrying any of these tags. Repeatable, or comma-separated.
|
|
7065
7442
|
*/
|
|
@@ -7087,7 +7464,7 @@ type ListPeopleData = {
|
|
|
7087
7464
|
/**
|
|
7088
7465
|
* Nobody with an account on these platforms. Repeatable, or comma-separated.
|
|
7089
7466
|
*/
|
|
7090
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7467
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7091
7468
|
/**
|
|
7092
7469
|
* Nobody carrying any of these tags. Repeatable, or comma-separated.
|
|
7093
7470
|
*/
|
|
@@ -7167,7 +7544,7 @@ type ListPeopleResponses = {
|
|
|
7167
7544
|
/**
|
|
7168
7545
|
* Platform of the canonical account; `accounts` lists every account.
|
|
7169
7546
|
*/
|
|
7170
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
7547
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
7171
7548
|
/**
|
|
7172
7549
|
* Display name as of their newest post; null when the platform has none.
|
|
7173
7550
|
*/
|
|
@@ -7190,9 +7567,9 @@ type ListPeopleResponses = {
|
|
|
7190
7567
|
*/
|
|
7191
7568
|
id: string;
|
|
7192
7569
|
/**
|
|
7193
|
-
* 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).
|
|
7570
|
+
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, 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).
|
|
7194
7571
|
*/
|
|
7195
|
-
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
7572
|
+
platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
|
|
7196
7573
|
/**
|
|
7197
7574
|
* Display name as the platform reports it.
|
|
7198
7575
|
*/
|
|
@@ -7352,7 +7729,7 @@ type UpdatePersonData = {
|
|
|
7352
7729
|
tags?: Array<string>;
|
|
7353
7730
|
notes?: string;
|
|
7354
7731
|
/**
|
|
7355
|
-
* true hides their posts from the feed,
|
|
7732
|
+
* true hides their posts from the feed, alerts and digests; false shows them again. Without groupId for the whole workspace; with it, for that group's keywords only.
|
|
7356
7733
|
*/
|
|
7357
7734
|
muted?: boolean;
|
|
7358
7735
|
/**
|
|
@@ -7567,6 +7944,12 @@ type LogPersonActivityData = {
|
|
|
7567
7944
|
*/
|
|
7568
7945
|
memberId?: string;
|
|
7569
7946
|
};
|
|
7947
|
+
headers?: {
|
|
7948
|
+
/**
|
|
7949
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
7950
|
+
*/
|
|
7951
|
+
'idempotency-key'?: string;
|
|
7952
|
+
};
|
|
7570
7953
|
path: {
|
|
7571
7954
|
/**
|
|
7572
7955
|
* Person id (aut_...).
|
|
@@ -7641,6 +8024,31 @@ type DeletePersonActivityResponses = {
|
|
|
7641
8024
|
204: void;
|
|
7642
8025
|
};
|
|
7643
8026
|
type DeletePersonActivityResponse = DeletePersonActivityResponses[keyof DeletePersonActivityResponses];
|
|
8027
|
+
type ListSegmentPresetsData = {
|
|
8028
|
+
body?: never;
|
|
8029
|
+
path?: never;
|
|
8030
|
+
query?: never;
|
|
8031
|
+
url: '/v1/segments/presets';
|
|
8032
|
+
};
|
|
8033
|
+
type ListSegmentPresetsErrors = {
|
|
8034
|
+
/**
|
|
8035
|
+
* Missing or invalid API key
|
|
8036
|
+
*/
|
|
8037
|
+
401: ErrorResponse;
|
|
8038
|
+
};
|
|
8039
|
+
type ListSegmentPresetsError = ListSegmentPresetsErrors[keyof ListSegmentPresetsErrors];
|
|
8040
|
+
type ListSegmentPresetsResponses = {
|
|
8041
|
+
/**
|
|
8042
|
+
* The presets
|
|
8043
|
+
*/
|
|
8044
|
+
200: {
|
|
8045
|
+
/**
|
|
8046
|
+
* Starting points you can save with POST /v1/segments.
|
|
8047
|
+
*/
|
|
8048
|
+
data: Array<SegmentPreset>;
|
|
8049
|
+
};
|
|
8050
|
+
};
|
|
8051
|
+
type ListSegmentPresetsResponse = ListSegmentPresetsResponses[keyof ListSegmentPresetsResponses];
|
|
7644
8052
|
type ListSegmentsData = {
|
|
7645
8053
|
body?: never;
|
|
7646
8054
|
path?: never;
|
|
@@ -7665,7 +8073,7 @@ type ListSegmentsErrors = {
|
|
|
7665
8073
|
type ListSegmentsError = ListSegmentsErrors[keyof ListSegmentsErrors];
|
|
7666
8074
|
type ListSegmentsResponses = {
|
|
7667
8075
|
/**
|
|
7668
|
-
* Every segment
|
|
8076
|
+
* Every segment
|
|
7669
8077
|
*/
|
|
7670
8078
|
200: {
|
|
7671
8079
|
data: Array<{
|
|
@@ -7679,7 +8087,7 @@ type ListSegmentsResponses = {
|
|
|
7679
8087
|
/**
|
|
7680
8088
|
* People with an account on any of these platforms.
|
|
7681
8089
|
*/
|
|
7682
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8090
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7683
8091
|
/**
|
|
7684
8092
|
* People carrying any of these tags.
|
|
7685
8093
|
*/
|
|
@@ -7715,7 +8123,7 @@ type ListSegmentsResponses = {
|
|
|
7715
8123
|
/**
|
|
7716
8124
|
* Nobody with an account on these platforms.
|
|
7717
8125
|
*/
|
|
7718
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8126
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7719
8127
|
/**
|
|
7720
8128
|
* Nobody carrying any of these tags.
|
|
7721
8129
|
*/
|
|
@@ -7767,87 +8175,11 @@ type ListSegmentsResponses = {
|
|
|
7767
8175
|
updatedAt: string;
|
|
7768
8176
|
}>;
|
|
7769
8177
|
/**
|
|
7770
|
-
* Starting points you can save with POST /v1/segments.
|
|
8178
|
+
* Deprecated: use GET /v1/segments/presets. Starting points you can save with POST /v1/segments.
|
|
8179
|
+
*
|
|
8180
|
+
* @deprecated
|
|
7771
8181
|
*/
|
|
7772
|
-
presets: Array<
|
|
7773
|
-
key: string;
|
|
7774
|
-
name: string;
|
|
7775
|
-
description: string;
|
|
7776
|
-
filter: {
|
|
7777
|
-
/**
|
|
7778
|
-
* People with an account on any of these platforms.
|
|
7779
|
-
*/
|
|
7780
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7781
|
-
/**
|
|
7782
|
-
* People carrying any of these tags.
|
|
7783
|
-
*/
|
|
7784
|
-
tags?: Array<string>;
|
|
7785
|
-
/**
|
|
7786
|
-
* At least this many followers. Unknown reach never matches.
|
|
7787
|
-
*/
|
|
7788
|
-
minFollowers?: number;
|
|
7789
|
-
/**
|
|
7790
|
-
* At most this many followers. Unknown reach never matches.
|
|
7791
|
-
*/
|
|
7792
|
-
maxFollowers?: number;
|
|
7793
|
-
/**
|
|
7794
|
-
* At least this many matched mentions.
|
|
7795
|
-
*/
|
|
7796
|
-
minMentions?: number;
|
|
7797
|
-
/**
|
|
7798
|
-
* At least this many negative mentions.
|
|
7799
|
-
*/
|
|
7800
|
-
minNegative?: number;
|
|
7801
|
-
/**
|
|
7802
|
-
* At least one mention carrying any of these intents.
|
|
7803
|
-
*/
|
|
7804
|
-
intents?: Array<string>;
|
|
7805
|
-
/**
|
|
7806
|
-
* Mentioned a keyword of any of these kinds.
|
|
7807
|
-
*/
|
|
7808
|
-
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
7809
|
-
/**
|
|
7810
|
-
* Never mentioned a keyword of these kinds.
|
|
7811
|
-
*/
|
|
7812
|
-
neverKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
7813
|
-
/**
|
|
7814
|
-
* Nobody with an account on these platforms.
|
|
7815
|
-
*/
|
|
7816
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7817
|
-
/**
|
|
7818
|
-
* Nobody carrying any of these tags.
|
|
7819
|
-
*/
|
|
7820
|
-
notTags?: Array<string>;
|
|
7821
|
-
/**
|
|
7822
|
-
* Nobody whose mentions carry any of these intents.
|
|
7823
|
-
*/
|
|
7824
|
-
notIntents?: Array<string>;
|
|
7825
|
-
/**
|
|
7826
|
-
* First seen within this many days.
|
|
7827
|
-
*/
|
|
7828
|
-
newSinceDays?: number;
|
|
7829
|
-
/**
|
|
7830
|
-
* At least one mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
7831
|
-
*/
|
|
7832
|
-
linkHosts?: Array<string>;
|
|
7833
|
-
/**
|
|
7834
|
-
* true: only muted people; false: only unmuted.
|
|
7835
|
-
*/
|
|
7836
|
-
muted?: boolean;
|
|
7837
|
-
/**
|
|
7838
|
-
* People at any of these outreach stages.
|
|
7839
|
-
*/
|
|
7840
|
-
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
7841
|
-
/**
|
|
7842
|
-
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
|
|
7843
|
-
*/
|
|
7844
|
-
automated?: boolean;
|
|
7845
|
-
/**
|
|
7846
|
-
* People owned by any of these members (user ids); "none" matches people nobody owns.
|
|
7847
|
-
*/
|
|
7848
|
-
ownerIds?: Array<string>;
|
|
7849
|
-
};
|
|
7850
|
-
}>;
|
|
8182
|
+
presets: Array<SegmentPreset>;
|
|
7851
8183
|
};
|
|
7852
8184
|
};
|
|
7853
8185
|
type ListSegmentsResponse = ListSegmentsResponses[keyof ListSegmentsResponses];
|
|
@@ -7859,7 +8191,7 @@ type CreateSegmentData = {
|
|
|
7859
8191
|
/**
|
|
7860
8192
|
* People with an account on any of these platforms.
|
|
7861
8193
|
*/
|
|
7862
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8194
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7863
8195
|
/**
|
|
7864
8196
|
* People carrying any of these tags.
|
|
7865
8197
|
*/
|
|
@@ -7895,7 +8227,7 @@ type CreateSegmentData = {
|
|
|
7895
8227
|
/**
|
|
7896
8228
|
* Nobody with an account on these platforms.
|
|
7897
8229
|
*/
|
|
7898
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8230
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
7899
8231
|
/**
|
|
7900
8232
|
* Nobody carrying any of these tags.
|
|
7901
8233
|
*/
|
|
@@ -7930,6 +8262,12 @@ type CreateSegmentData = {
|
|
|
7930
8262
|
ownerIds?: Array<string>;
|
|
7931
8263
|
};
|
|
7932
8264
|
};
|
|
8265
|
+
headers?: {
|
|
8266
|
+
/**
|
|
8267
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
8268
|
+
*/
|
|
8269
|
+
'idempotency-key'?: string;
|
|
8270
|
+
};
|
|
7933
8271
|
path?: never;
|
|
7934
8272
|
query?: {
|
|
7935
8273
|
/**
|
|
@@ -8047,7 +8385,7 @@ type UpdateSegmentData = {
|
|
|
8047
8385
|
/**
|
|
8048
8386
|
* People with an account on any of these platforms.
|
|
8049
8387
|
*/
|
|
8050
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8388
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8051
8389
|
/**
|
|
8052
8390
|
* People carrying any of these tags.
|
|
8053
8391
|
*/
|
|
@@ -8083,7 +8421,7 @@ type UpdateSegmentData = {
|
|
|
8083
8421
|
/**
|
|
8084
8422
|
* Nobody with an account on these platforms.
|
|
8085
8423
|
*/
|
|
8086
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8424
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8087
8425
|
/**
|
|
8088
8426
|
* Nobody carrying any of these tags.
|
|
8089
8427
|
*/
|
|
@@ -8210,11 +8548,11 @@ type ListViewsResponses = {
|
|
|
8210
8548
|
/**
|
|
8211
8549
|
* Only posts from any of these platforms.
|
|
8212
8550
|
*/
|
|
8213
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8551
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8214
8552
|
/**
|
|
8215
8553
|
* Never posts from these platforms.
|
|
8216
8554
|
*/
|
|
8217
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8555
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8218
8556
|
/**
|
|
8219
8557
|
* Only mentions in this status: open, ignored, done.
|
|
8220
8558
|
*/
|
|
@@ -8314,6 +8652,10 @@ type ListViewsResponses = {
|
|
|
8314
8652
|
/**
|
|
8315
8653
|
* Never these authors: display names, handles or profile URLs.
|
|
8316
8654
|
*/
|
|
8655
|
+
notAuthors?: Array<string>;
|
|
8656
|
+
/**
|
|
8657
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
8658
|
+
*/
|
|
8317
8659
|
excludeAuthors?: Array<string>;
|
|
8318
8660
|
/**
|
|
8319
8661
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
@@ -8348,7 +8690,7 @@ type ListViewsResponses = {
|
|
|
8348
8690
|
*/
|
|
8349
8691
|
minBookmarks?: number;
|
|
8350
8692
|
/**
|
|
8351
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
8693
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
8352
8694
|
*/
|
|
8353
8695
|
anyOf?: Array<FilterGroup>;
|
|
8354
8696
|
};
|
|
@@ -8405,11 +8747,11 @@ type CreateViewData = {
|
|
|
8405
8747
|
/**
|
|
8406
8748
|
* Only posts from any of these platforms.
|
|
8407
8749
|
*/
|
|
8408
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8750
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8409
8751
|
/**
|
|
8410
8752
|
* Never posts from these platforms.
|
|
8411
8753
|
*/
|
|
8412
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8754
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8413
8755
|
/**
|
|
8414
8756
|
* Only mentions in this status: open, ignored, done.
|
|
8415
8757
|
*/
|
|
@@ -8509,6 +8851,10 @@ type CreateViewData = {
|
|
|
8509
8851
|
/**
|
|
8510
8852
|
* Never these authors: display names, handles or profile URLs.
|
|
8511
8853
|
*/
|
|
8854
|
+
notAuthors?: Array<string>;
|
|
8855
|
+
/**
|
|
8856
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
8857
|
+
*/
|
|
8512
8858
|
excludeAuthors?: Array<string>;
|
|
8513
8859
|
/**
|
|
8514
8860
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
@@ -8543,11 +8889,17 @@ type CreateViewData = {
|
|
|
8543
8889
|
*/
|
|
8544
8890
|
minBookmarks?: number;
|
|
8545
8891
|
/**
|
|
8546
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
8892
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
8547
8893
|
*/
|
|
8548
8894
|
anyOf?: Array<FilterGroup>;
|
|
8549
8895
|
};
|
|
8550
8896
|
};
|
|
8897
|
+
headers?: {
|
|
8898
|
+
/**
|
|
8899
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
8900
|
+
*/
|
|
8901
|
+
'idempotency-key'?: string;
|
|
8902
|
+
};
|
|
8551
8903
|
path?: never;
|
|
8552
8904
|
query?: never;
|
|
8553
8905
|
url: '/v1/views';
|
|
@@ -8667,11 +9019,11 @@ type UpdateViewData = {
|
|
|
8667
9019
|
/**
|
|
8668
9020
|
* Only posts from any of these platforms.
|
|
8669
9021
|
*/
|
|
8670
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9022
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8671
9023
|
/**
|
|
8672
9024
|
* Never posts from these platforms.
|
|
8673
9025
|
*/
|
|
8674
|
-
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9026
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8675
9027
|
/**
|
|
8676
9028
|
* Only mentions in this status: open, ignored, done.
|
|
8677
9029
|
*/
|
|
@@ -8771,6 +9123,10 @@ type UpdateViewData = {
|
|
|
8771
9123
|
/**
|
|
8772
9124
|
* Never these authors: display names, handles or profile URLs.
|
|
8773
9125
|
*/
|
|
9126
|
+
notAuthors?: Array<string>;
|
|
9127
|
+
/**
|
|
9128
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
9129
|
+
*/
|
|
8774
9130
|
excludeAuthors?: Array<string>;
|
|
8775
9131
|
/**
|
|
8776
9132
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
@@ -8805,7 +9161,7 @@ type UpdateViewData = {
|
|
|
8805
9161
|
*/
|
|
8806
9162
|
minBookmarks?: number;
|
|
8807
9163
|
/**
|
|
8808
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
9164
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
8809
9165
|
*/
|
|
8810
9166
|
anyOf?: Array<FilterGroup>;
|
|
8811
9167
|
};
|
|
@@ -8984,10 +9340,16 @@ type CreateGroupData = {
|
|
|
8984
9340
|
*/
|
|
8985
9341
|
externalId?: string | null;
|
|
8986
9342
|
/**
|
|
8987
|
-
* What the classifier reads as "the company" for this group's keywords,
|
|
9343
|
+
* What the classifier reads as "the company" for this group's keywords, instead of the WHOLE workspace profile (guidelines and competitors included). Null: the workspace profile. See [Groups](/guides/groups#a-company-description-per-group).
|
|
8988
9344
|
*/
|
|
8989
9345
|
context?: string | null;
|
|
8990
9346
|
};
|
|
9347
|
+
headers?: {
|
|
9348
|
+
/**
|
|
9349
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
9350
|
+
*/
|
|
9351
|
+
'idempotency-key'?: string;
|
|
9352
|
+
};
|
|
8991
9353
|
path?: never;
|
|
8992
9354
|
query?: never;
|
|
8993
9355
|
url: '/v1/groups';
|
|
@@ -9086,7 +9448,7 @@ type UpdateGroupData = {
|
|
|
9086
9448
|
*/
|
|
9087
9449
|
externalId?: string | null;
|
|
9088
9450
|
/**
|
|
9089
|
-
* Replaces the group's company description; null clears it
|
|
9451
|
+
* Replaces the group's company description; null clears it. New mentions are judged with it at once, old ones are not rescored. Not on the default group (400 default_group_context).
|
|
9090
9452
|
*/
|
|
9091
9453
|
context?: string | null;
|
|
9092
9454
|
};
|
|
@@ -9266,6 +9628,12 @@ type CreateApiKeyData = {
|
|
|
9266
9628
|
*/
|
|
9267
9629
|
expiresAt?: string;
|
|
9268
9630
|
};
|
|
9631
|
+
headers?: {
|
|
9632
|
+
/**
|
|
9633
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
9634
|
+
*/
|
|
9635
|
+
'idempotency-key'?: string;
|
|
9636
|
+
};
|
|
9269
9637
|
path?: never;
|
|
9270
9638
|
query?: never;
|
|
9271
9639
|
url: '/v1/api-keys';
|
|
@@ -9422,6 +9790,12 @@ type CreateInvitationData = {
|
|
|
9422
9790
|
*/
|
|
9423
9791
|
role?: 'admin' | 'member';
|
|
9424
9792
|
};
|
|
9793
|
+
headers?: {
|
|
9794
|
+
/**
|
|
9795
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
9796
|
+
*/
|
|
9797
|
+
'idempotency-key'?: string;
|
|
9798
|
+
};
|
|
9425
9799
|
path?: never;
|
|
9426
9800
|
query?: never;
|
|
9427
9801
|
url: '/v1/members/invitations';
|
|
@@ -9577,7 +9951,7 @@ type GetUsageBreakdownData = {
|
|
|
9577
9951
|
/**
|
|
9578
9952
|
* Only these platforms. A keyword-day belongs to no platform, so with this filter the keyword line reads 0 and only mentions and comments count. Repeatable, or comma-separated.
|
|
9579
9953
|
*/
|
|
9580
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9954
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9581
9955
|
/**
|
|
9582
9956
|
* Rows per page, 1 to 500 (default 100). Only by=keyword can outgrow a page; a window has at most 90 days and a dozen platforms.
|
|
9583
9957
|
*/
|
|
@@ -9622,6 +9996,12 @@ type CreateTopUpData = {
|
|
|
9622
9996
|
*/
|
|
9623
9997
|
successUrl?: string;
|
|
9624
9998
|
};
|
|
9999
|
+
headers?: {
|
|
10000
|
+
/**
|
|
10001
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
10002
|
+
*/
|
|
10003
|
+
'idempotency-key'?: string;
|
|
10004
|
+
};
|
|
9625
10005
|
path?: never;
|
|
9626
10006
|
query?: never;
|
|
9627
10007
|
url: '/v1/billing/top-ups';
|
|
@@ -9690,7 +10070,7 @@ type ListLedgerData = {
|
|
|
9690
10070
|
*/
|
|
9691
10071
|
cursor?: string;
|
|
9692
10072
|
/**
|
|
9693
|
-
* Page size, 1 to 100 (default
|
|
10073
|
+
* Page size, 1 to 100 (default 50).
|
|
9694
10074
|
*/
|
|
9695
10075
|
limit?: number;
|
|
9696
10076
|
};
|
|
@@ -9853,9 +10233,9 @@ type UpdateAlertData = {
|
|
|
9853
10233
|
/**
|
|
9854
10234
|
* Only posts from these platforms.
|
|
9855
10235
|
*/
|
|
9856
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10236
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9857
10237
|
/**
|
|
9858
|
-
* The rule's relevance floor. Absent
|
|
10238
|
+
* The rule's relevance floor. Absent: relevant mentions only (40 and up); lower, down to 0, it also gets noise; higher, less. Email channels keep the 40 line. Unclassified mentions never pass.
|
|
9859
10239
|
*/
|
|
9860
10240
|
minRelevance?: number;
|
|
9861
10241
|
/**
|
|
@@ -9939,7 +10319,7 @@ type UpdateAlertData = {
|
|
|
9939
10319
|
*/
|
|
9940
10320
|
minBookmarks?: number;
|
|
9941
10321
|
/**
|
|
9942
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
10322
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
9943
10323
|
*/
|
|
9944
10324
|
anyOf?: Array<FilterGroup>;
|
|
9945
10325
|
};
|
|
@@ -10019,7 +10399,12 @@ type ListAlertsResponses = {
|
|
|
10019
10399
|
name: string;
|
|
10020
10400
|
enabled: boolean;
|
|
10021
10401
|
/**
|
|
10022
|
-
*
|
|
10402
|
+
* When it sends; see [Alerts](/alerts).
|
|
10403
|
+
*
|
|
10404
|
+
* - instant: each matching mention as it happens.
|
|
10405
|
+
* - hourly: the previous UTC hour, at five past; never email.
|
|
10406
|
+
* - daily: one digest at the scheduled local time.
|
|
10407
|
+
* - weekly: one digest a week, on schedule.weekday.
|
|
10023
10408
|
*/
|
|
10024
10409
|
mode: 'instant' | 'hourly' | 'daily' | 'weekly';
|
|
10025
10410
|
filter: {
|
|
@@ -10034,9 +10419,9 @@ type ListAlertsResponses = {
|
|
|
10034
10419
|
/**
|
|
10035
10420
|
* Only posts from these platforms.
|
|
10036
10421
|
*/
|
|
10037
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10422
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10038
10423
|
/**
|
|
10039
|
-
* The rule's relevance floor. Absent
|
|
10424
|
+
* The rule's relevance floor. Absent: relevant mentions only (40 and up); lower, down to 0, it also gets noise; higher, less. Email channels keep the 40 line. Unclassified mentions never pass.
|
|
10040
10425
|
*/
|
|
10041
10426
|
minRelevance?: number;
|
|
10042
10427
|
/**
|
|
@@ -10120,7 +10505,7 @@ type ListAlertsResponses = {
|
|
|
10120
10505
|
*/
|
|
10121
10506
|
minBookmarks?: number;
|
|
10122
10507
|
/**
|
|
10123
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
10508
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
10124
10509
|
*/
|
|
10125
10510
|
anyOf?: Array<FilterGroup>;
|
|
10126
10511
|
};
|
|
@@ -10191,9 +10576,9 @@ type CreateAlertData = {
|
|
|
10191
10576
|
/**
|
|
10192
10577
|
* Only posts from these platforms.
|
|
10193
10578
|
*/
|
|
10194
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10579
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10195
10580
|
/**
|
|
10196
|
-
* The rule's relevance floor. Absent
|
|
10581
|
+
* The rule's relevance floor. Absent: relevant mentions only (40 and up); lower, down to 0, it also gets noise; higher, less. Email channels keep the 40 line. Unclassified mentions never pass.
|
|
10197
10582
|
*/
|
|
10198
10583
|
minRelevance?: number;
|
|
10199
10584
|
/**
|
|
@@ -10277,7 +10662,7 @@ type CreateAlertData = {
|
|
|
10277
10662
|
*/
|
|
10278
10663
|
minBookmarks?: number;
|
|
10279
10664
|
/**
|
|
10280
|
-
* OR across groups: a mention passes when it meets every condition of at least one group
|
|
10665
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
10281
10666
|
*/
|
|
10282
10667
|
anyOf?: Array<FilterGroup>;
|
|
10283
10668
|
};
|
|
@@ -10303,13 +10688,19 @@ type CreateAlertData = {
|
|
|
10303
10688
|
*/
|
|
10304
10689
|
channelIds?: Array<string>;
|
|
10305
10690
|
};
|
|
10691
|
+
headers?: {
|
|
10692
|
+
/**
|
|
10693
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
10694
|
+
*/
|
|
10695
|
+
'idempotency-key'?: string;
|
|
10696
|
+
};
|
|
10306
10697
|
path?: never;
|
|
10307
10698
|
query?: never;
|
|
10308
10699
|
url: '/v1/alerts';
|
|
10309
10700
|
};
|
|
10310
10701
|
type CreateAlertErrors = {
|
|
10311
10702
|
/**
|
|
10312
|
-
* A daily or weekly rule without a schedule
|
|
10703
|
+
* A daily or weekly rule without a schedule or weekday, an hourly one with a weekday or email channel (hourly_email_unsupported), an unknown channel, or anyOf groups too large (filter_too_complex)
|
|
10313
10704
|
*/
|
|
10314
10705
|
400: ErrorResponse;
|
|
10315
10706
|
/**
|
|
@@ -10392,7 +10783,7 @@ type RunAlertDigestResponses = {
|
|
|
10392
10783
|
*/
|
|
10393
10784
|
200: {
|
|
10394
10785
|
/**
|
|
10395
|
-
* Why nothing was sent
|
|
10786
|
+
* Why nothing was sent: the period already went out, nothing to show, an hourly retry window closed, or another run is sending it now.
|
|
10396
10787
|
*/
|
|
10397
10788
|
skipped: 'already_sent' | 'empty' | 'expired' | 'in_flight';
|
|
10398
10789
|
matched: number;
|
|
@@ -10506,7 +10897,7 @@ type GetAnalyticsSummaryData = {
|
|
|
10506
10897
|
/**
|
|
10507
10898
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
10508
10899
|
*/
|
|
10509
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10900
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10510
10901
|
/**
|
|
10511
10902
|
* true adds the period of the same length right before the window as `previous`.
|
|
10512
10903
|
*/
|
|
@@ -10559,7 +10950,7 @@ type GetAnalyticsSeriesData = {
|
|
|
10559
10950
|
/**
|
|
10560
10951
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
10561
10952
|
*/
|
|
10562
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10953
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10563
10954
|
/**
|
|
10564
10955
|
* true adds the period of the same length right before the window as `previous`.
|
|
10565
10956
|
*/
|
|
@@ -10620,7 +11011,7 @@ type GetAnalyticsBreakdownData = {
|
|
|
10620
11011
|
/**
|
|
10621
11012
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
10622
11013
|
*/
|
|
10623
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
11014
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10624
11015
|
/**
|
|
10625
11016
|
* true adds the period of the same length right before the window as `previous`.
|
|
10626
11017
|
*/
|
|
@@ -10630,7 +11021,17 @@ type GetAnalyticsBreakdownData = {
|
|
|
10630
11021
|
*/
|
|
10631
11022
|
timezone?: string;
|
|
10632
11023
|
/**
|
|
10633
|
-
* The dimension to group by:
|
|
11024
|
+
* The dimension to group by:
|
|
11025
|
+
*
|
|
11026
|
+
* - platform or keyword.
|
|
11027
|
+
* - sentiment: unclassified included.
|
|
11028
|
+
* - intent: a mention can carry several.
|
|
11029
|
+
* - status: open, ignored, done.
|
|
11030
|
+
* - hour: weekday and hour of day in `timezone`.
|
|
11031
|
+
* - person: who posted; anonymous posts are left out.
|
|
11032
|
+
* - language: ISO 639-1; "unknown" if none, "other" if unnamed.
|
|
11033
|
+
* - country: the author's, ISO 3166-1 alpha-2; "unknown", "other" likewise.
|
|
11034
|
+
* - subreddit: Reddit posts only; `share` stays of the whole window.
|
|
10634
11035
|
*/
|
|
10635
11036
|
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit';
|
|
10636
11037
|
};
|
|
@@ -10677,7 +11078,7 @@ type GetShareOfVoiceData = {
|
|
|
10677
11078
|
/**
|
|
10678
11079
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
10679
11080
|
*/
|
|
10680
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
11081
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10681
11082
|
/**
|
|
10682
11083
|
* true adds the period of the same length right before the window as `previous`.
|
|
10683
11084
|
*/
|
|
@@ -10730,7 +11131,7 @@ type GetReviewsReportData = {
|
|
|
10730
11131
|
/**
|
|
10731
11132
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
10732
11133
|
*/
|
|
10733
|
-
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
11134
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10734
11135
|
/**
|
|
10735
11136
|
* true adds the period of the same length right before the window as `previous`.
|
|
10736
11137
|
*/
|
|
@@ -10839,7 +11240,7 @@ type UpdateChannelData = {
|
|
|
10839
11240
|
[key: string]: string;
|
|
10840
11241
|
};
|
|
10841
11242
|
/**
|
|
10842
|
-
* Replaces the
|
|
11243
|
+
* Replaces the account events the channel receives; empty unsubscribes it from all. A webhook takes any; Slack, email and Telegram take the attention events only. See [Account events](/webhooks/account-events).
|
|
10843
11244
|
*/
|
|
10844
11245
|
events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
10845
11246
|
};
|
|
@@ -10947,6 +11348,13 @@ type ListChannelDeliveriesData = {
|
|
|
10947
11348
|
id: string;
|
|
10948
11349
|
};
|
|
10949
11350
|
query?: {
|
|
11351
|
+
/**
|
|
11352
|
+
* Opaque cursor from a previous page (`nextCursor`).
|
|
11353
|
+
*/
|
|
11354
|
+
cursor?: string;
|
|
11355
|
+
/**
|
|
11356
|
+
* How many deliveries, newest first, 1 to 200 (default 50).
|
|
11357
|
+
*/
|
|
10950
11358
|
limit?: number;
|
|
10951
11359
|
};
|
|
10952
11360
|
url: '/v1/channels/{id}/deliveries';
|
|
@@ -11009,6 +11417,10 @@ type ListChannelDeliveriesResponses = {
|
|
|
11009
11417
|
text: string;
|
|
11010
11418
|
} | null;
|
|
11011
11419
|
}>;
|
|
11420
|
+
/**
|
|
11421
|
+
* Pass back as `cursor` for the next page; null on the last page.
|
|
11422
|
+
*/
|
|
11423
|
+
nextCursor: string | null;
|
|
11012
11424
|
};
|
|
11013
11425
|
};
|
|
11014
11426
|
type ListChannelDeliveriesResponse = ListChannelDeliveriesResponses[keyof ListChannelDeliveriesResponses];
|
|
@@ -11042,6 +11454,12 @@ type CreateChannelData = {
|
|
|
11042
11454
|
} & CreateEmailChannel) | ({
|
|
11043
11455
|
kind: 'webhook';
|
|
11044
11456
|
} & CreateWebhookChannel);
|
|
11457
|
+
headers?: {
|
|
11458
|
+
/**
|
|
11459
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
11460
|
+
*/
|
|
11461
|
+
'idempotency-key'?: string;
|
|
11462
|
+
};
|
|
11045
11463
|
path?: never;
|
|
11046
11464
|
query?: never;
|
|
11047
11465
|
url: '/v1/channels';
|
|
@@ -11082,17 +11500,28 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
|
|
|
11082
11500
|
*/
|
|
11083
11501
|
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
11084
11502
|
};
|
|
11503
|
+
/**
|
|
11504
|
+
* Check the API is up
|
|
11505
|
+
*/
|
|
11085
11506
|
declare const getHealth: <ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>) => RequestResult<GetHealthResponses, unknown, ThrowOnError>;
|
|
11086
11507
|
/**
|
|
11087
11508
|
* List keywords
|
|
11088
11509
|
*
|
|
11089
|
-
*
|
|
11510
|
+
* List the workspace's keywords with their match stats and poll health, newest first.
|
|
11511
|
+
*
|
|
11512
|
+
* `q` searches term and context; the other parameters filter, sort and page; `total` counts matches before paging.
|
|
11090
11513
|
*/
|
|
11091
11514
|
declare const listKeywords: <ThrowOnError extends boolean = false>(options?: Options<ListKeywordsData, ThrowOnError>) => RequestResult<ListKeywordsResponses, ListKeywordsErrors, ThrowOnError>;
|
|
11092
11515
|
/**
|
|
11093
11516
|
* Track a keyword
|
|
11094
11517
|
*
|
|
11095
|
-
* Start tracking a word or phrase
|
|
11518
|
+
* Start tracking a word or phrase; mentions arrive from the next poll.
|
|
11519
|
+
*
|
|
11520
|
+
* - $5 a month, charged daily; up to 500 per funded workspace.
|
|
11521
|
+
* - `matching` filters posts before they are stored, so rejected posts never bill.
|
|
11522
|
+
* - `cap` limits matched mentions per period.
|
|
11523
|
+
*
|
|
11524
|
+
* See [Keywords](/guides/keywords).
|
|
11096
11525
|
*/
|
|
11097
11526
|
declare const createKeyword: <ThrowOnError extends boolean = false>(options: Options<CreateKeywordData, ThrowOnError>) => RequestResult<CreateKeywordResponses, CreateKeywordErrors, ThrowOnError>;
|
|
11098
11527
|
/**
|
|
@@ -11108,37 +11537,57 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
|
|
|
11108
11537
|
/**
|
|
11109
11538
|
* Update a keyword
|
|
11110
11539
|
*
|
|
11111
|
-
*
|
|
11540
|
+
* Change a keyword's term, mute, kind, platforms, context, matching rules or mention cap.
|
|
11541
|
+
*
|
|
11542
|
+
* - A new `term` is tracked from now on, no look-back; old mentions stay.
|
|
11543
|
+
* - An empty rule list clears it; `cap` null removes the cap.
|
|
11544
|
+
* - Changes apply to new mentions only.
|
|
11112
11545
|
*/
|
|
11113
11546
|
declare const updateKeyword: <ThrowOnError extends boolean = false>(options: Options<UpdateKeywordData, ThrowOnError>) => RequestResult<UpdateKeywordResponses, UpdateKeywordErrors, ThrowOnError>;
|
|
11114
11547
|
/**
|
|
11115
11548
|
* Get a keyword's health
|
|
11116
11549
|
*
|
|
11117
|
-
*
|
|
11550
|
+
* Report whether a keyword earns what it costs, with reasons and suggested fixes.
|
|
11551
|
+
*
|
|
11552
|
+
* - Each suggestion has a `patch` for PATCH /v1/keywords/{id} and its measured effect.
|
|
11553
|
+
* - Read only, never billed, cached 5 minutes; 30 reads a minute.
|
|
11554
|
+
*
|
|
11555
|
+
* See [Keyword health](/guides/keyword-health).
|
|
11118
11556
|
*/
|
|
11119
11557
|
declare const getKeywordHealth: <ThrowOnError extends boolean = false>(options: Options<GetKeywordHealthData, ThrowOnError>) => RequestResult<GetKeywordHealthResponses, GetKeywordHealthErrors, ThrowOnError>;
|
|
11120
11558
|
/**
|
|
11121
11559
|
* Duplicate a keyword
|
|
11122
11560
|
*
|
|
11123
|
-
*
|
|
11561
|
+
* Create a keyword with this one's settings under a new term or group.
|
|
11562
|
+
*
|
|
11563
|
+
* It copies kind, platforms, context, rules, cap and comments; review apps and feeds only via `include`. A new keyword: $5 a month and a 30-day look-back.
|
|
11124
11564
|
*/
|
|
11125
11565
|
declare const duplicateKeyword: <ThrowOnError extends boolean = false>(options: Options<DuplicateKeywordData, ThrowOnError>) => RequestResult<DuplicateKeywordResponses, DuplicateKeywordErrors, ThrowOnError>;
|
|
11126
11566
|
/**
|
|
11127
11567
|
* List feeds
|
|
11128
11568
|
*
|
|
11129
|
-
*
|
|
11569
|
+
* List the workspace's RSS and Atom feeds, newest first, each with its poll health.
|
|
11570
|
+
*
|
|
11571
|
+
* Keywords with readsWorkspaceFeeds (the default) read them hourly, for free; matching items bill as mentions. See [RSS](/platforms/rss#workspace-feeds).
|
|
11130
11572
|
*/
|
|
11131
11573
|
declare const listFeeds: <ThrowOnError extends boolean = false>(options?: Options<ListFeedsData, ThrowOnError>) => RequestResult<ListFeedsResponses, ListFeedsErrors, ThrowOnError>;
|
|
11132
11574
|
/**
|
|
11133
11575
|
* Connect a feed
|
|
11134
11576
|
*
|
|
11135
|
-
* Connect an RSS or Atom feed
|
|
11577
|
+
* Connect an RSS or Atom feed, or a page advertising one, for the workspace's keywords to read hourly.
|
|
11578
|
+
*
|
|
11579
|
+
* - Idempotent: a feed already read returns 200.
|
|
11580
|
+
* - A members-only forum answers `feed_login_required`: resend with `auth`.
|
|
11581
|
+
*
|
|
11582
|
+
* See [RSS](/platforms/rss#workspace-feeds).
|
|
11136
11583
|
*/
|
|
11137
11584
|
declare const createFeed: <ThrowOnError extends boolean = false>(options: Options<CreateFeedData, ThrowOnError>) => RequestResult<CreateFeedResponses, CreateFeedErrors, ThrowOnError>;
|
|
11138
11585
|
/**
|
|
11139
11586
|
* Connect many feeds
|
|
11140
11587
|
*
|
|
11141
|
-
* Connect up to 100 feeds in one call, each
|
|
11588
|
+
* Connect up to 100 feeds in one call, each reported added, already or failed, in order.
|
|
11589
|
+
*
|
|
11590
|
+
* A failure never stops the others and carries the code POST /v1/feeds would answer. Only the first 8 added bring a look-back. See [RSS](/platforms/rss#workspace-feeds).
|
|
11142
11591
|
*/
|
|
11143
11592
|
declare const importFeeds: <ThrowOnError extends boolean = false>(options: Options<ImportFeedsData, ThrowOnError>) => RequestResult<ImportFeedsResponses, ImportFeedsErrors, ThrowOnError>;
|
|
11144
11593
|
/**
|
|
@@ -11154,121 +11603,182 @@ declare const getFeed: <ThrowOnError extends boolean = false>(options: Options<G
|
|
|
11154
11603
|
/**
|
|
11155
11604
|
* Update a feed
|
|
11156
11605
|
*
|
|
11157
|
-
* Rename a feed
|
|
11606
|
+
* Rename a feed, or set its sign-in for a members-only forum.
|
|
11607
|
+
*
|
|
11608
|
+
* `auth` is a browser cookie or one header (such as Discourse's Api-Key), checked, stored encrypted and never shown; the feed is then read for this workspace alone. null removes it.
|
|
11158
11609
|
*/
|
|
11159
11610
|
declare const updateFeed: <ThrowOnError extends boolean = false>(options: Options<UpdateFeedData, ThrowOnError>) => RequestResult<UpdateFeedResponses, UpdateFeedErrors, ThrowOnError>;
|
|
11160
11611
|
/**
|
|
11161
11612
|
* Get the workspace filters
|
|
11162
11613
|
*
|
|
11163
|
-
*
|
|
11614
|
+
* Read the workspace's noise rules, applied to every keyword before a mention is stored.
|
|
11615
|
+
*
|
|
11616
|
+
* A rejected post is never classified, delivered or billed. Keyword rules (`matching`) apply too.
|
|
11164
11617
|
*/
|
|
11165
11618
|
declare const getFilters: <ThrowOnError extends boolean = false>(options?: Options<GetFiltersData, ThrowOnError>) => RequestResult<GetFiltersResponses, GetFiltersErrors, ThrowOnError>;
|
|
11166
11619
|
/**
|
|
11167
11620
|
* Update the workspace filters
|
|
11168
11621
|
*
|
|
11169
|
-
* Replace any of the lists;
|
|
11622
|
+
* Replace any of the workspace's noise-rule lists; omitted lists stay, empty ones clear.
|
|
11623
|
+
*
|
|
11624
|
+
* Entries are stored canonically (lowercase terms, authors as profile links or names, owner/name repositories, subreddits without r/). Applies to new mentions within a minute.
|
|
11170
11625
|
*/
|
|
11171
11626
|
declare const updateFilters: <ThrowOnError extends boolean = false>(options: Options<UpdateFiltersData, ThrowOnError>) => RequestResult<UpdateFiltersResponses, UpdateFiltersErrors, ThrowOnError>;
|
|
11172
11627
|
/**
|
|
11173
11628
|
* Get a mention
|
|
11174
11629
|
*
|
|
11175
|
-
*
|
|
11630
|
+
* Get one mention by id, as it appears in the list.
|
|
11631
|
+
*
|
|
11632
|
+
* It carries the post, its author with reach and your tags, the classification, the priority score and the triage fields. Ids belong to your organization; any other id is a 404.
|
|
11176
11633
|
*/
|
|
11177
11634
|
declare const getMention: <ThrowOnError extends boolean = false>(options: Options<GetMentionData, ThrowOnError>) => RequestResult<GetMentionResponses, GetMentionErrors, ThrowOnError>;
|
|
11178
11635
|
/**
|
|
11179
11636
|
* Update a mention
|
|
11180
11637
|
*
|
|
11181
|
-
*
|
|
11638
|
+
* Triage, assign, snooze, annotate or correct the classification of a mention.
|
|
11639
|
+
*
|
|
11640
|
+
* - `relevant` and `sentiment` are your verdict; every list, digest and report follows it. null restores the classifier's.
|
|
11641
|
+
* - Omitted fields stay. Delivery and billing never change.
|
|
11182
11642
|
*/
|
|
11183
11643
|
declare const updateMention: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionData, ThrowOnError>) => RequestResult<UpdateMentionResponses, UpdateMentionErrors, ThrowOnError>;
|
|
11184
11644
|
/**
|
|
11185
11645
|
* List mentions
|
|
11186
11646
|
*
|
|
11187
|
-
*
|
|
11647
|
+
* List the mentions matched to your keywords, newest match first, filtered and cursor-paginated.
|
|
11648
|
+
*
|
|
11649
|
+
* - A mention is one post matched to one keyword.
|
|
11650
|
+
* - `sort=priority` ranks the last 30 days by attention score.
|
|
11651
|
+
* - `alertId` applies that alert rule's filter; `anyOf` adds OR. See [Conventions](/conventions#or-across-groups-anyof).
|
|
11188
11652
|
*/
|
|
11189
11653
|
declare const searchMentions: <ThrowOnError extends boolean = false>(options?: Options<SearchMentionsData, ThrowOnError>) => RequestResult<SearchMentionsResponses, SearchMentionsErrors, ThrowOnError>;
|
|
11190
11654
|
/**
|
|
11191
11655
|
* Export mentions as CSV
|
|
11192
11656
|
*
|
|
11193
|
-
*
|
|
11657
|
+
* Export the mentions GET /v1/mentions would list as CSV, newest matched first.
|
|
11658
|
+
*
|
|
11659
|
+
* - Capped at 10,000 rows; X-Mentions-Truncated says when cut.
|
|
11660
|
+
* - 6 exports a minute per workspace.
|
|
11661
|
+
*
|
|
11662
|
+
* Columns: see [Exports](/guides/exports).
|
|
11194
11663
|
*/
|
|
11195
11664
|
declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
|
|
11196
11665
|
/**
|
|
11197
11666
|
* List the comments of a mention
|
|
11198
11667
|
*
|
|
11199
|
-
*
|
|
11668
|
+
* List the comments under a mention's post, newest first, whether or not they name your keyword.
|
|
11669
|
+
*
|
|
11670
|
+
* Filled for relevant mentions of keywords with comments on, read several times as the thread grows; each comment delivered costs $0.008. See [Comments](/guides/comments).
|
|
11200
11671
|
*/
|
|
11201
11672
|
declare const listMentionComments: <ThrowOnError extends boolean = false>(options: Options<ListMentionCommentsData, ThrowOnError>) => RequestResult<ListMentionCommentsResponses, ListMentionCommentsErrors, ThrowOnError>;
|
|
11202
11673
|
/**
|
|
11203
11674
|
* Export mentions as JSON
|
|
11204
11675
|
*
|
|
11205
|
-
*
|
|
11676
|
+
* Export the mentions GET /v1/mentions would list as one JSON response, newest matched first.
|
|
11677
|
+
*
|
|
11678
|
+
* - Full Mention objects, capped at 10,000; `truncated` says when cut.
|
|
11679
|
+
* - Shares the CSV export's 6 a minute.
|
|
11680
|
+
*
|
|
11681
|
+
* See [Exports](/guides/exports).
|
|
11206
11682
|
*/
|
|
11207
11683
|
declare const exportMentionsJson: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsJsonData, ThrowOnError>) => RequestResult<ExportMentionsJsonResponses, ExportMentionsJsonErrors, ThrowOnError>;
|
|
11208
11684
|
/**
|
|
11209
11685
|
* Export people as CSV
|
|
11210
11686
|
*
|
|
11211
|
-
*
|
|
11687
|
+
* Export the GET /v1/people list as CSV, one row per person with contact and outreach columns.
|
|
11688
|
+
*
|
|
11689
|
+
* Capped at 5,000 people; 6 exports a minute. See [Exports](/guides/exports#people-columns).
|
|
11212
11690
|
*/
|
|
11213
11691
|
declare const exportPeopleCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportPeopleCsvData, ThrowOnError>) => RequestResult<ExportPeopleCsvResponses, ExportPeopleCsvErrors, ThrowOnError>;
|
|
11214
11692
|
/**
|
|
11215
11693
|
* List people
|
|
11216
11694
|
*
|
|
11217
|
-
*
|
|
11695
|
+
* List the people behind your mentions, with accounts, reach, profile, stats, your annotations and outreach.
|
|
11696
|
+
*
|
|
11697
|
+
* Filter by platform, tag, followers, counts, intents, keyword kinds, outreach, automated or segment; offset-paginated. `groupId` scopes it to one keyword group. See [People](/guides/people).
|
|
11218
11698
|
*/
|
|
11219
11699
|
declare const listPeople: <ThrowOnError extends boolean = false>(options?: Options<ListPeopleData, ThrowOnError>) => RequestResult<ListPeopleResponses, ListPeopleErrors, ThrowOnError>;
|
|
11220
11700
|
/**
|
|
11221
11701
|
* Get a person
|
|
11222
11702
|
*
|
|
11223
|
-
* One person as your workspace sees them. An account merged into someone resolves to that person.
|
|
11703
|
+
* One person as your workspace sees them. An account merged into someone resolves to that person.
|
|
11704
|
+
*
|
|
11705
|
+
* With `groupId`, it acts inside that keyword group; see [Groups](/guides/groups#people-and-segments-by-group).
|
|
11224
11706
|
*/
|
|
11225
11707
|
declare const getPerson: <ThrowOnError extends boolean = false>(options: Options<GetPersonData, ThrowOnError>) => RequestResult<GetPersonResponses, GetPersonErrors, ThrowOnError>;
|
|
11226
11708
|
/**
|
|
11227
11709
|
* Update your annotations on a person
|
|
11228
11710
|
*
|
|
11229
|
-
*
|
|
11711
|
+
* Set a person's tags, notes, mute, outreach owner and stage, for your workspace only.
|
|
11712
|
+
*
|
|
11713
|
+
* Mute hides their posts from the feed and every channel; billing never changes. With `groupId` the annotations are that group's own; see [People](/guides/people).
|
|
11230
11714
|
*/
|
|
11231
11715
|
declare const updatePerson: <ThrowOnError extends boolean = false>(options: Options<UpdatePersonData, ThrowOnError>) => RequestResult<UpdatePersonResponses, UpdatePersonErrors, ThrowOnError>;
|
|
11232
11716
|
/**
|
|
11233
11717
|
* Merge an account into a person
|
|
11234
11718
|
*
|
|
11235
|
-
* Declare that this account and another person are the same human, for your workspace only.
|
|
11719
|
+
* Declare that this account and another person are the same human, for your workspace only.
|
|
11720
|
+
*
|
|
11721
|
+
* Everything combines under `into`, which keeps its owner and stage unless it had none.
|
|
11722
|
+
*
|
|
11723
|
+
* With `groupId`, it acts inside that keyword group; see [Groups](/guides/groups#people-and-segments-by-group).
|
|
11236
11724
|
*/
|
|
11237
11725
|
declare const mergePeople: <ThrowOnError extends boolean = false>(options: Options<MergePeopleData, ThrowOnError>) => RequestResult<MergePeopleResponses, MergePeopleErrors, ThrowOnError>;
|
|
11238
11726
|
/**
|
|
11239
11727
|
* Undo a merge
|
|
11240
11728
|
*
|
|
11241
|
-
* The account becomes its own person again.
|
|
11729
|
+
* The account becomes its own person again.
|
|
11730
|
+
*
|
|
11731
|
+
* With `groupId`, it acts inside that keyword group; see [Groups](/guides/groups#people-and-segments-by-group).
|
|
11242
11732
|
*/
|
|
11243
11733
|
declare const splitPerson: <ThrowOnError extends boolean = false>(options: Options<SplitPersonData, ThrowOnError>) => RequestResult<SplitPersonResponses, SplitPersonErrors, ThrowOnError>;
|
|
11244
11734
|
/**
|
|
11245
11735
|
* List outreach activities
|
|
11246
11736
|
*
|
|
11247
|
-
*
|
|
11737
|
+
* List every logged contact with this person, newest first (at most 200): who, channel, when, note.
|
|
11738
|
+
*
|
|
11739
|
+
* Read it before reaching out.
|
|
11740
|
+
*
|
|
11741
|
+
* With `groupId`, it acts inside that keyword group; see [Groups](/guides/groups#people-and-segments-by-group).
|
|
11248
11742
|
*/
|
|
11249
11743
|
declare const listPersonActivities: <ThrowOnError extends boolean = false>(options: Options<ListPersonActivitiesData, ThrowOnError>) => RequestResult<ListPersonActivitiesResponses, ListPersonActivitiesErrors, ThrowOnError>;
|
|
11250
11744
|
/**
|
|
11251
11745
|
* Log an outreach activity
|
|
11252
11746
|
*
|
|
11253
|
-
* Record that a teammate reached out to this person: an email, a DM, a call.
|
|
11747
|
+
* Record that a teammate reached out to this person: an email, a DM, a call.
|
|
11748
|
+
*
|
|
11749
|
+
* The first claims an unowned person and marks them contacted; without `memberId`, a key's activity claims nobody.
|
|
11750
|
+
*
|
|
11751
|
+
* With `groupId`, it acts inside that keyword group; see [Groups](/guides/groups#people-and-segments-by-group).
|
|
11254
11752
|
*/
|
|
11255
11753
|
declare const logPersonActivity: <ThrowOnError extends boolean = false>(options: Options<LogPersonActivityData, ThrowOnError>) => RequestResult<LogPersonActivityResponses, LogPersonActivityErrors, ThrowOnError>;
|
|
11256
11754
|
/**
|
|
11257
11755
|
* Delete an outreach activity
|
|
11258
11756
|
*
|
|
11259
|
-
* Remove a contact logged by mistake. The person's owner and stage stay as they are.
|
|
11757
|
+
* Remove a contact logged by mistake. The person's owner and stage stay as they are.
|
|
11758
|
+
*
|
|
11759
|
+
* With `groupId`, it acts inside that keyword group; see [Groups](/guides/groups#people-and-segments-by-group).
|
|
11260
11760
|
*/
|
|
11261
11761
|
declare const deletePersonActivity: <ThrowOnError extends boolean = false>(options: Options<DeletePersonActivityData, ThrowOnError>) => RequestResult<DeletePersonActivityResponses, DeletePersonActivityErrors, ThrowOnError>;
|
|
11762
|
+
/**
|
|
11763
|
+
* List segment presets
|
|
11764
|
+
*
|
|
11765
|
+
* Suggested segments to start from, the same for every workspace. Save one with POST /v1/segments and its `filter`.
|
|
11766
|
+
*/
|
|
11767
|
+
declare const listSegmentPresets: <ThrowOnError extends boolean = false>(options?: Options<ListSegmentPresetsData, ThrowOnError>) => RequestResult<ListSegmentPresetsResponses, ListSegmentPresetsErrors, ThrowOnError>;
|
|
11262
11768
|
/**
|
|
11263
11769
|
* List segments
|
|
11264
11770
|
*
|
|
11265
|
-
*
|
|
11771
|
+
* List your saved segments with live member counts.
|
|
11772
|
+
*
|
|
11773
|
+
* Pass a segment id to GET /v1/people for its members. `groupId` reads that group's own segments; each belongs to one scope.
|
|
11266
11774
|
*/
|
|
11267
11775
|
declare const listSegments: <ThrowOnError extends boolean = false>(options?: Options<ListSegmentsData, ThrowOnError>) => RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError>;
|
|
11268
11776
|
/**
|
|
11269
11777
|
* Create a segment
|
|
11270
11778
|
*
|
|
11271
|
-
* Save a named filter over your people.
|
|
11779
|
+
* Save a named filter over your people.
|
|
11780
|
+
*
|
|
11781
|
+
* With `groupId` the segment belongs to that keyword group: it is listed, counted and changed only there, and its name only has to be unique in the group.
|
|
11272
11782
|
*/
|
|
11273
11783
|
declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError>;
|
|
11274
11784
|
/**
|
|
@@ -11292,13 +11802,17 @@ declare const updateSegment: <ThrowOnError extends boolean = false>(options: Opt
|
|
|
11292
11802
|
/**
|
|
11293
11803
|
* List views
|
|
11294
11804
|
*
|
|
11295
|
-
*
|
|
11805
|
+
* List the workspace's saved views, oldest first.
|
|
11806
|
+
*
|
|
11807
|
+
* A view is a named filter over mentions: pass its id as `viewId` to GET /v1/mentions or the export to read exactly what it selects.
|
|
11296
11808
|
*/
|
|
11297
11809
|
declare const listViews: <ThrowOnError extends boolean = false>(options?: Options<ListViewsData, ThrowOnError>) => RequestResult<ListViewsResponses, ListViewsErrors, ThrowOnError>;
|
|
11298
11810
|
/**
|
|
11299
11811
|
* Save a view
|
|
11300
11812
|
*
|
|
11301
|
-
* Save a named filter over mentions
|
|
11813
|
+
* Save a named filter over mentions, evaluated whenever it is read.
|
|
11814
|
+
*
|
|
11815
|
+
* The filter takes GET /v1/mentions' fields plus `anyOf`; an empty filter is every mention. See [Views](/guides/views).
|
|
11302
11816
|
*/
|
|
11303
11817
|
declare const createView: <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => RequestResult<CreateViewResponses, CreateViewErrors, ThrowOnError>;
|
|
11304
11818
|
/**
|
|
@@ -11320,31 +11834,41 @@ declare const updateView: <ThrowOnError extends boolean = false>(options: Option
|
|
|
11320
11834
|
/**
|
|
11321
11835
|
* List attention items
|
|
11322
11836
|
*
|
|
11323
|
-
*
|
|
11837
|
+
* List what needs a person, newest first: mention spikes, negative sentiment jumps, noisy keywords and failing channels.
|
|
11838
|
+
*
|
|
11839
|
+
* Checked hourly; items resolve on their own. Open items by default, `status=all` for history. Each opening is also an account event. See [Attention](/guides/attention).
|
|
11324
11840
|
*/
|
|
11325
11841
|
declare const listAttention: <ThrowOnError extends boolean = false>(options?: Options<ListAttentionData, ThrowOnError>) => RequestResult<ListAttentionResponses, ListAttentionErrors, ThrowOnError>;
|
|
11326
11842
|
/**
|
|
11327
11843
|
* Dismiss an attention item
|
|
11328
11844
|
*
|
|
11329
|
-
* Put an item away.
|
|
11845
|
+
* Put an attention item away. Idempotent.
|
|
11846
|
+
*
|
|
11847
|
+
* It leaves the open list and does not come back while its condition lasts. Once the condition clears, a new episode may open a new item.
|
|
11330
11848
|
*/
|
|
11331
11849
|
declare const dismissAttention: <ThrowOnError extends boolean = false>(options: Options<DismissAttentionData, ThrowOnError>) => RequestResult<DismissAttentionResponses, DismissAttentionErrors, ThrowOnError>;
|
|
11332
11850
|
/**
|
|
11333
11851
|
* List groups
|
|
11334
11852
|
*
|
|
11335
|
-
*
|
|
11853
|
+
* List the workspace's keyword groups, default first, then oldest first.
|
|
11854
|
+
*
|
|
11855
|
+
* A term may be tracked once per group. Pass `externalId` to find the group carrying your own id. See [Groups](/guides/groups).
|
|
11336
11856
|
*/
|
|
11337
11857
|
declare const listGroups: <ThrowOnError extends boolean = false>(options?: Options<ListGroupsData, ThrowOnError>) => RequestResult<ListGroupsResponses, ListGroupsErrors, ThrowOnError>;
|
|
11338
11858
|
/**
|
|
11339
11859
|
* Create a group
|
|
11340
11860
|
*
|
|
11341
|
-
* Create a keyword group
|
|
11861
|
+
* Create a keyword group, then pass its id as `groupId` when creating keywords.
|
|
11862
|
+
*
|
|
11863
|
+
* `externalId` is your own id for it; `context` is its company description, read instead of the workspace profile. See [Groups](/guides/groups).
|
|
11342
11864
|
*/
|
|
11343
11865
|
declare const createGroup: <ThrowOnError extends boolean = false>(options: Options<CreateGroupData, ThrowOnError>) => RequestResult<CreateGroupResponses, CreateGroupErrors, ThrowOnError>;
|
|
11344
11866
|
/**
|
|
11345
11867
|
* Delete a group and its keywords
|
|
11346
11868
|
*
|
|
11347
|
-
*
|
|
11869
|
+
* Delete a group and EVERY keyword in it, with their mentions.
|
|
11870
|
+
*
|
|
11871
|
+
* Alert rules naming them are adjusted; charges stay on the usage record. The default group cannot be deleted. The group's `stats.keywords` says how many go.
|
|
11348
11872
|
*/
|
|
11349
11873
|
declare const deleteGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteGroupData, ThrowOnError>) => RequestResult<DeleteGroupResponses, DeleteGroupErrors, ThrowOnError>;
|
|
11350
11874
|
/**
|
|
@@ -11354,7 +11878,9 @@ declare const getGroup: <ThrowOnError extends boolean = false>(options: Options<
|
|
|
11354
11878
|
/**
|
|
11355
11879
|
* Update a group
|
|
11356
11880
|
*
|
|
11357
|
-
* Rename a group, change
|
|
11881
|
+
* Rename a group, or change its `externalId` or company description (`context`); null clears either.
|
|
11882
|
+
*
|
|
11883
|
+
* New mentions use a new description at once; old ones are not rescored. The default group takes no description.
|
|
11358
11884
|
*/
|
|
11359
11885
|
declare const updateGroup: <ThrowOnError extends boolean = false>(options: Options<UpdateGroupData, ThrowOnError>) => RequestResult<UpdateGroupResponses, UpdateGroupErrors, ThrowOnError>;
|
|
11360
11886
|
/**
|
|
@@ -11376,7 +11902,9 @@ declare const listApiKeys: <ThrowOnError extends boolean = false>(options?: Opti
|
|
|
11376
11902
|
/**
|
|
11377
11903
|
* Create an API key
|
|
11378
11904
|
*
|
|
11379
|
-
* Mint
|
|
11905
|
+
* Mint an API key for this workspace. The key itself is returned once; only its hash is stored.
|
|
11906
|
+
*
|
|
11907
|
+
* `expiresAt` makes it stop working at an instant (a key for a contractor or a one-off script); it stays listed until revoked.
|
|
11380
11908
|
*/
|
|
11381
11909
|
declare const createApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>) => RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
|
|
11382
11910
|
/**
|
|
@@ -11388,7 +11916,9 @@ declare const revokeApiKey: <ThrowOnError extends boolean = false>(options: Opti
|
|
|
11388
11916
|
/**
|
|
11389
11917
|
* Introspect the credential
|
|
11390
11918
|
*
|
|
11391
|
-
*
|
|
11919
|
+
* Show the workspace this credential acts on, how it authenticated, whether it may write, and a key's id and expiry.
|
|
11920
|
+
*
|
|
11921
|
+
* Run it first: a read key answers 403 read_only_key on every write.
|
|
11392
11922
|
*/
|
|
11393
11923
|
declare const whoami: <ThrowOnError extends boolean = false>(options?: Options<WhoamiData, ThrowOnError>) => RequestResult<WhoamiResponses, WhoamiErrors, ThrowOnError>;
|
|
11394
11924
|
/**
|
|
@@ -11406,7 +11936,9 @@ declare const listInvitations: <ThrowOnError extends boolean = false>(options?:
|
|
|
11406
11936
|
/**
|
|
11407
11937
|
* Invite a member
|
|
11408
11938
|
*
|
|
11409
|
-
*
|
|
11939
|
+
* Invite someone by email as admin or member; the invitation expires after 48 hours.
|
|
11940
|
+
*
|
|
11941
|
+
* Idempotent for an open invitation (200, no second email); a member is 409 already_member. Needs a signed-in owner or admin: API keys get 403.
|
|
11410
11942
|
*/
|
|
11411
11943
|
declare const createInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateInvitationData, ThrowOnError>) => RequestResult<CreateInvitationResponses, CreateInvitationErrors, ThrowOnError>;
|
|
11412
11944
|
/**
|
|
@@ -11418,43 +11950,60 @@ declare const revokeInvitation: <ThrowOnError extends boolean = false>(options:
|
|
|
11418
11950
|
/**
|
|
11419
11951
|
* Remove a member
|
|
11420
11952
|
*
|
|
11421
|
-
*
|
|
11953
|
+
* Remove a member; access ends within a minute, while their mentions, notes and outreach stay.
|
|
11954
|
+
*
|
|
11955
|
+
* Needs a signed-in owner or admin; only an owner removes an owner, and never the last (409 last_owner).
|
|
11422
11956
|
*/
|
|
11423
11957
|
declare const removeMember: <ThrowOnError extends boolean = false>(options: Options<RemoveMemberData, ThrowOnError>) => RequestResult<RemoveMemberResponses, RemoveMemberErrors, ThrowOnError>;
|
|
11424
11958
|
/**
|
|
11425
11959
|
* Get usage and balance
|
|
11426
11960
|
*
|
|
11427
|
-
*
|
|
11961
|
+
* Read the balance, daily burn, keywords running and paused, and recent matches: the short form of GET /v1/billing/wallet.
|
|
11962
|
+
*
|
|
11963
|
+
* Every matched mention bills $0.008, relevant or not; every active keyword $5 a month, charged daily. See [Billing](/billing).
|
|
11428
11964
|
*/
|
|
11429
11965
|
declare const getUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) => RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError>;
|
|
11430
11966
|
/**
|
|
11431
11967
|
* Get the usage breakdown
|
|
11432
11968
|
*
|
|
11433
|
-
*
|
|
11969
|
+
* Report what the workspace was charged over a window at list price, grouped by one dimension (`by`).
|
|
11970
|
+
*
|
|
11971
|
+
* - Rows are paged; the window's totals come on every call.
|
|
11972
|
+
* - 30 reads a minute per workspace.
|
|
11973
|
+
*
|
|
11974
|
+
* See [Cost per keyword](/billing#cost-per-keyword).
|
|
11434
11975
|
*/
|
|
11435
11976
|
declare const getUsageBreakdown: <ThrowOnError extends boolean = false>(options?: Options<GetUsageBreakdownData, ThrowOnError>) => RequestResult<GetUsageBreakdownResponses, GetUsageBreakdownErrors, ThrowOnError>;
|
|
11436
11977
|
/**
|
|
11437
11978
|
* Create a top-up checkout
|
|
11438
11979
|
*
|
|
11439
|
-
*
|
|
11980
|
+
* Get a hosted checkout URL for a top-up; this call charges nothing.
|
|
11981
|
+
*
|
|
11982
|
+
* The balance is credited within a minute of payment, and paused tracking resumes. `successUrl` must be on a trusted origin; omit it for the dashboard.
|
|
11440
11983
|
*/
|
|
11441
11984
|
declare const createTopUp: <ThrowOnError extends boolean = false>(options: Options<CreateTopUpData, ThrowOnError>) => RequestResult<CreateTopUpResponses, CreateTopUpErrors, ThrowOnError>;
|
|
11442
11985
|
/**
|
|
11443
11986
|
* Get the wallet
|
|
11444
11987
|
*
|
|
11445
|
-
*
|
|
11988
|
+
* Read the prepaid balance in full; GET /v1/usage is the short form.
|
|
11989
|
+
*
|
|
11990
|
+
* It adds what a day costs, what a resume needs, the welcome credit, the newest top-up, top-up bounds and auto-recharge settings.
|
|
11446
11991
|
*/
|
|
11447
11992
|
declare const getWallet: <ThrowOnError extends boolean = false>(options?: Options<GetWalletData, ThrowOnError>) => RequestResult<GetWalletResponses, GetWalletErrors, ThrowOnError>;
|
|
11448
11993
|
/**
|
|
11449
11994
|
* List ledger entries
|
|
11450
11995
|
*
|
|
11451
|
-
*
|
|
11996
|
+
* List every movement of the balance, newest first, cursor paged.
|
|
11997
|
+
*
|
|
11998
|
+
* Rows are the welcome credit, top-ups, refunds, the daily keyword-day and mention debits, and adjustments. A debit row carries the UTC day it settled and the cumulative units behind it.
|
|
11452
11999
|
*/
|
|
11453
12000
|
declare const listLedger: <ThrowOnError extends boolean = false>(options?: Options<ListLedgerData, ThrowOnError>) => RequestResult<ListLedgerResponses, ListLedgerErrors, ThrowOnError>;
|
|
11454
12001
|
/**
|
|
11455
12002
|
* List receipts
|
|
11456
12003
|
*
|
|
11457
|
-
*
|
|
12004
|
+
* List the top-up orders, newest first, as Polar (the merchant of record) holds them.
|
|
12005
|
+
*
|
|
12006
|
+
* This workspace's share of the billing customer's newest 100 orders; empty before the first top-up.
|
|
11458
12007
|
*/
|
|
11459
12008
|
declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError>;
|
|
11460
12009
|
/**
|
|
@@ -11482,7 +12031,12 @@ declare const listAlerts: <ThrowOnError extends boolean = false>(options?: Optio
|
|
|
11482
12031
|
/**
|
|
11483
12032
|
* Create an alert
|
|
11484
12033
|
*
|
|
11485
|
-
*
|
|
12034
|
+
* Create an alert: a rule (what to watch) sent to channels.
|
|
12035
|
+
*
|
|
12036
|
+
* - `mode`: instant, or hourly, daily or weekly digests; hourly never emails.
|
|
12037
|
+
* - `filter.anyOf` adds OR groups of conditions.
|
|
12038
|
+
*
|
|
12039
|
+
* See [Alerts](/alerts).
|
|
11486
12040
|
*/
|
|
11487
12041
|
declare const createAlert: <ThrowOnError extends boolean = false>(options: Options<CreateAlertData, ThrowOnError>) => RequestResult<CreateAlertResponses, CreateAlertErrors, ThrowOnError>;
|
|
11488
12042
|
/**
|
|
@@ -11496,43 +12050,61 @@ declare const runAlertDigest: <ThrowOnError extends boolean = false>(options: Op
|
|
|
11496
12050
|
/**
|
|
11497
12051
|
* Mute authors on an alert
|
|
11498
12052
|
*
|
|
11499
|
-
* Add authors to the alert's muted list
|
|
12053
|
+
* Add authors to the alert's muted list, leaving the rest of its filter.
|
|
12054
|
+
*
|
|
12055
|
+
* A post link mutes its author; already muted authors are skipped, so retries are safe. An entry naming no person (a subreddit) is a 400. See [Alerts](/alerts#mute-authors).
|
|
11500
12056
|
*/
|
|
11501
12057
|
declare const muteAlertAuthors: <ThrowOnError extends boolean = false>(options: Options<MuteAlertAuthorsData, ThrowOnError>) => RequestResult<MuteAlertAuthorsResponses, MuteAlertAuthorsErrors, ThrowOnError>;
|
|
11502
12058
|
/**
|
|
11503
12059
|
* Unmute authors on an alert
|
|
11504
12060
|
*
|
|
11505
|
-
* Remove authors from the alert's muted list without touching the rest of its filter.
|
|
12061
|
+
* Remove authors from the alert's muted list without touching the rest of its filter.
|
|
12062
|
+
*
|
|
12063
|
+
* Name each one by the stored entry or by any link to that profile or its posts. Authors that are not muted are ignored, so a retry is safe.
|
|
11506
12064
|
*/
|
|
11507
12065
|
declare const unmuteAlertAuthors: <ThrowOnError extends boolean = false>(options: Options<UnmuteAlertAuthorsData, ThrowOnError>) => RequestResult<UnmuteAlertAuthorsResponses, UnmuteAlertAuthorsErrors, ThrowOnError>;
|
|
11508
12066
|
/**
|
|
11509
12067
|
* Headline counts for a window
|
|
11510
12068
|
*
|
|
11511
|
-
*
|
|
12069
|
+
* Summarize matched and relevant mentions, posts, people, sentiment, intent, reach and triage over a window.
|
|
12070
|
+
*
|
|
12071
|
+
* The window is `range` or `from` and `to`, in `timezone`, by publish date; `compare=true` adds the period before.
|
|
11512
12072
|
*/
|
|
11513
12073
|
declare const getAnalyticsSummary: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSummaryData, ThrowOnError>) => RequestResult<GetAnalyticsSummaryResponses, GetAnalyticsSummaryErrors, ThrowOnError>;
|
|
11514
12074
|
/**
|
|
11515
12075
|
* Mentions over time
|
|
11516
12076
|
*
|
|
11517
|
-
*
|
|
12077
|
+
* Count matched, relevant and sentiment mentions per day or week, in total or per platform or keyword (`by`).
|
|
12078
|
+
*
|
|
12079
|
+
* The window is `range` or `from` and `to`, in `timezone`, by publish date; `compare=true` adds the period before.
|
|
11518
12080
|
*/
|
|
11519
12081
|
declare const getAnalyticsSeries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSeriesData, ThrowOnError>) => RequestResult<GetAnalyticsSeriesResponses, GetAnalyticsSeriesErrors, ThrowOnError>;
|
|
11520
12082
|
/**
|
|
11521
12083
|
* Mentions grouped by one dimension
|
|
11522
12084
|
*
|
|
11523
|
-
*
|
|
12085
|
+
* Count matched, relevant and sentiment mentions in one table, grouped by one dimension (`by`).
|
|
12086
|
+
*
|
|
12087
|
+
* The window is `range` or `from` and `to`, in `timezone`, by publish date; `compare=true` adds the period before.
|
|
11524
12088
|
*/
|
|
11525
12089
|
declare const getAnalyticsBreakdown: <ThrowOnError extends boolean = false>(options: Options<GetAnalyticsBreakdownData, ThrowOnError>) => RequestResult<GetAnalyticsBreakdownResponses, GetAnalyticsBreakdownErrors, ThrowOnError>;
|
|
11526
12090
|
/**
|
|
11527
12091
|
* Brand against competitors
|
|
11528
12092
|
*
|
|
11529
|
-
*
|
|
12093
|
+
* List every keyword matched in the window with its share of brand plus competitor matches.
|
|
12094
|
+
*
|
|
12095
|
+
* Topic keywords are counted but stay out of the split.
|
|
12096
|
+
*
|
|
12097
|
+
* The window is `range` or `from` and `to`, in `timezone`, by publish date; `compare=true` adds the period before.
|
|
11530
12098
|
*/
|
|
11531
12099
|
declare const getShareOfVoice: <ThrowOnError extends boolean = false>(options?: Options<GetShareOfVoiceData, ThrowOnError>) => RequestResult<GetShareOfVoiceResponses, GetShareOfVoiceErrors, ThrowOnError>;
|
|
11532
12100
|
/**
|
|
11533
12101
|
* Reviews: stars over a window, per review page
|
|
11534
12102
|
*
|
|
11535
|
-
*
|
|
12103
|
+
* Report on your keywords' reviews: count, average stars, distribution, replies and open 1-2 star reviews.
|
|
12104
|
+
*
|
|
12105
|
+
* Per page too, with unhappy reviews' tags; each review counts once.
|
|
12106
|
+
*
|
|
12107
|
+
* The window is `range` or `from` and `to`, in `timezone`, by publish date; `compare=true` adds the period before.
|
|
11536
12108
|
*/
|
|
11537
12109
|
declare const getReviewsReport: <ThrowOnError extends boolean = false>(options?: Options<GetReviewsReportData, ThrowOnError>) => RequestResult<GetReviewsReportResponses, GetReviewsReportErrors, ThrowOnError>;
|
|
11538
12110
|
/**
|
|
@@ -11630,6 +12202,7 @@ declare const sdk_listMembers: typeof listMembers;
|
|
|
11630
12202
|
declare const sdk_listMentionComments: typeof listMentionComments;
|
|
11631
12203
|
declare const sdk_listPeople: typeof listPeople;
|
|
11632
12204
|
declare const sdk_listPersonActivities: typeof listPersonActivities;
|
|
12205
|
+
declare const sdk_listSegmentPresets: typeof listSegmentPresets;
|
|
11633
12206
|
declare const sdk_listSegments: typeof listSegments;
|
|
11634
12207
|
declare const sdk_listViews: typeof listViews;
|
|
11635
12208
|
declare const sdk_logPersonActivity: typeof logPersonActivity;
|
|
@@ -11658,7 +12231,7 @@ declare const sdk_updateSegment: typeof updateSegment;
|
|
|
11658
12231
|
declare const sdk_updateView: typeof updateView;
|
|
11659
12232
|
declare const sdk_whoami: typeof whoami;
|
|
11660
12233
|
declare namespace sdk {
|
|
11661
|
-
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createFeed as createFeed, 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_deleteFeed as deleteFeed, 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_duplicateKeyword as duplicateKeyword, 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_getFeed as getFeed, 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_importFeeds as importFeeds, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listFeeds as listFeeds, 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_updateFeed as updateFeed, 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 };
|
|
12234
|
+
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createFeed as createFeed, 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_deleteFeed as deleteFeed, 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_duplicateKeyword as duplicateKeyword, 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_getFeed as getFeed, 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_importFeeds as importFeeds, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listFeeds as listFeeds, 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_listSegmentPresets as listSegmentPresets, 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_updateFeed as updateFeed, 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 };
|
|
11662
12235
|
}
|
|
11663
12236
|
|
|
11664
12237
|
/**
|
|
@@ -11686,4 +12259,4 @@ type Mentio = typeof sdk & {
|
|
|
11686
12259
|
};
|
|
11687
12260
|
declare function createMentio(options: MentioOptions): Mentio;
|
|
11688
12261
|
|
|
11689
|
-
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 CreateFeedData, type CreateFeedError, type CreateFeedErrors, type CreateFeedResponse, type CreateFeedResponses, 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 DeleteFeedData, type DeleteFeedError, type DeleteFeedErrors, type DeleteFeedResponse, type DeleteFeedResponses, 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 DuplicateKeywordData, type DuplicateKeywordError, type DuplicateKeywordErrors, type DuplicateKeywordResponse, type DuplicateKeywordResponses, 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 Feed, type FeedFailingEventData, 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 GetFeedData, type GetFeedError, type GetFeedErrors, type GetFeedResponse, type GetFeedResponses, 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 ImportFeedsData, type ImportFeedsError, type ImportFeedsErrors, type ImportFeedsResponse, type ImportFeedsResponses, 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 ListFeedsData, type ListFeedsError, type ListFeedsErrors, type ListFeedsResponse, type ListFeedsResponses, 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 UpdateFeedData, type UpdateFeedError, type UpdateFeedErrors, type UpdateFeedResponse, type UpdateFeedResponses, 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, createFeed, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteFeed, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, duplicateKeyword, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFeed, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, importFeeds, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listFeeds, 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, updateFeed, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|
|
12262
|
+
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 CreateFeedData, type CreateFeedError, type CreateFeedErrors, type CreateFeedResponse, type CreateFeedResponses, 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 DeleteFeedData, type DeleteFeedError, type DeleteFeedErrors, type DeleteFeedResponse, type DeleteFeedResponses, 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 DuplicateKeywordData, type DuplicateKeywordError, type DuplicateKeywordErrors, type DuplicateKeywordResponse, type DuplicateKeywordResponses, 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 Feed, type FeedFailingEventData, 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 GetFeedData, type GetFeedError, type GetFeedErrors, type GetFeedResponse, type GetFeedResponses, 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 ImportFeedsData, type ImportFeedsError, type ImportFeedsErrors, type ImportFeedsResponse, type ImportFeedsResponses, 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 ListFeedsData, type ListFeedsError, type ListFeedsErrors, type ListFeedsResponse, type ListFeedsResponses, 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 ListSegmentPresetsData, type ListSegmentPresetsError, type ListSegmentPresetsErrors, type ListSegmentPresetsResponse, type ListSegmentPresetsResponses, 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 SegmentPreset, 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 UpdateFeedData, type UpdateFeedError, type UpdateFeedErrors, type UpdateFeedResponse, type UpdateFeedResponses, 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, createFeed, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteFeed, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, duplicateKeyword, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFeed, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, importFeeds, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listFeeds, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSegmentPresets, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFeed, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|