@mentio-dev/sdk 0.14.0 → 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 CHANGED
@@ -407,7 +407,7 @@ type Keyword = {
407
407
  */
408
408
  pausedForBalance: boolean;
409
409
  /**
410
- * Muted by the noise brake: on a workspace running on its welcome credit, at least 20 of its matches were scored and under 30% were relevant. A change of its required or excluded terms, platforms or context resumes it (when the balance covers another day), and so does unmuting; a top-up does not.
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 (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
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,23 +448,54 @@ type Keyword = {
448
448
  resumesAt: string | null;
449
449
  } | null;
450
450
  /**
451
- * Comments under this keyword's mentions: when enabled, the comments of every mention scored relevant are read from 30 minutes after the post, on a schedule per platform (for a day on Reddit, Hacker News and Bluesky, a week on GitHub, Stack Overflow and DEV, a month on YouTube) (new comments only, at most maxPerPost a thread, comments of fewer than three words dropped), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments.
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, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
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, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
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
+ /**
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
+ */
466
+ display: {
467
+ /**
468
+ * By the language the post is written in (ISO 639-1).
469
+ */
470
+ languages: {
471
+ /**
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
+ */
474
+ only: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
475
+ /**
476
+ * A post whose language is listed is hidden.
477
+ */
478
+ excluded: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
479
+ };
480
+ /**
481
+ * By where the author is (ISO 3166-1 alpha-2), as the classifier read their profile and the post.
482
+ */
483
+ countries: {
484
+ /**
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
+ */
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
+ /**
489
+ * A post whose author's country is listed is hidden.
490
+ */
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
+ };
493
+ };
463
494
  group: GroupRef;
464
495
  /**
465
496
  * Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
466
497
  */
467
- 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;
468
499
  /**
469
500
  * RSS and Atom feeds this keyword reads; empty for none.
470
501
  */
@@ -478,7 +509,7 @@ type Keyword = {
478
509
  */
479
510
  reviewSources: Array<ReviewSource>;
480
511
  /**
481
- * A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
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.
482
513
  */
483
514
  context: string | null;
484
515
  /**
@@ -494,7 +525,7 @@ type Keyword = {
494
525
  */
495
526
  requiredMode: 'any' | 'all';
496
527
  /**
497
- * Combinations of terms, at most 50 of 10 terms each: the post must ALSO contain every term of at least one group (an OR of ANDs). For the keyword inreach, [["weather", "alert*"], ["tsunami"], ["flash flood"]] keeps a post about inReach weather alerts, tsunamis or flash floods, one keyword instead of three. Same phrase and wildcard rules as requiredTerms; when both are set a post must pass both. Empty: no 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).
498
529
  */
499
530
  requiredGroups: Array<Array<string>>;
500
531
  /**
@@ -510,7 +541,7 @@ type Keyword = {
510
541
  */
511
542
  caseSensitive: boolean;
512
543
  /**
513
- * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
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).
514
545
  */
515
546
  exactPhrase: boolean;
516
547
  /**
@@ -531,7 +562,12 @@ type Keyword = {
531
562
  */
532
563
  repositories: {
533
564
  /**
534
- * The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
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.
535
571
  */
536
572
  events: Array<'new' | 'traction' | 'stars' | 'growth'>;
537
573
  /**
@@ -539,7 +575,7 @@ type Keyword = {
539
575
  */
540
576
  minStars: number | null;
541
577
  /**
542
- * Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
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.
543
579
  */
544
580
  minWeeklyStars: number | null;
545
581
  };
@@ -599,11 +635,18 @@ type Keyword = {
599
635
  noisy: boolean;
600
636
  };
601
637
  /**
602
- * The keyword's health over the same 14 days as `noise`, by the rule GET /v1/keywords/{id}/health applies to its own window: paused (muted), capped (at its mention cap), noisy (20 or more scored matches, under 30% relevant), new (under 7 days old and not noisy, or changed in the last 7 days with under 20 scored matches since), quiet (7 days or older, nothing relevant), else healthy. Judged on the matches since the keyword's last change to its matching rules, platforms or context (or its unmute) when that is inside the 14 days, so a keyword tightened today is not flagged on the noise the change removed; `noise` itself keeps the whole 14 days. Always 14 days, while the endpoint reads 30 by default, so the two can differ for the same keyword. The health endpoint says why and what to change.
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.
603
646
  */
604
647
  health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
605
648
  /**
606
- * What this keyword has cost this calendar month (UTC) at list price: exactly its row in GET /v1/usage/breakdown?month=<this month> (same tables, same rounding). The wallet's ledger, which settles once a day, is what can differ from these list-price numbers, and only by cumulative rounding.
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.
607
650
  */
608
651
  cost: {
609
652
  /**
@@ -641,9 +684,9 @@ type Keyword = {
641
684
  */
642
685
  polling: Array<{
643
686
  /**
644
- * 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).
645
688
  */
646
- 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';
647
690
  /**
648
691
  * Newest poll of this platform for the term; null until the first one.
649
692
  */
@@ -666,7 +709,7 @@ type ErrorResponse = {
666
709
  /**
667
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.
668
711
  */
669
- 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';
670
713
  /**
671
714
  * Human-readable detail; may change between releases.
672
715
  */
@@ -699,7 +742,7 @@ type KeywordSuggestion = {
699
742
  */
700
743
  patch: {
701
744
  /**
702
- * Renames the keyword: the new term is tracked from now on, with no look-back, and the keyword keeps its id, its settings and the mentions the old term found. Wrap it in double quotes for the exact phrase only. A 409 when its group already tracks the new term.
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.
703
746
  */
704
747
  term?: string;
705
748
  /**
@@ -713,9 +756,9 @@ type KeywordSuggestion = {
713
756
  /**
714
757
  * Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).
715
758
  */
716
- 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;
717
760
  /**
718
- * A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
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.
719
762
  */
720
763
  context?: string | null;
721
764
  /**
@@ -731,7 +774,7 @@ type KeywordSuggestion = {
731
774
  */
732
775
  requiredMode?: 'any' | 'all';
733
776
  /**
734
- * Combinations of terms, at most 50 of 10 terms each: the post must ALSO contain every term of at least one group (an OR of ANDs). For the keyword inreach, [["weather", "alert*"], ["tsunami"], ["flash flood"]] keeps a post about inReach weather alerts, tsunamis or flash floods, one keyword instead of three. Same phrase and wildcard rules as requiredTerms; when both are set a post must pass both. Empty: no 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).
735
778
  */
736
779
  requiredGroups?: Array<Array<string>>;
737
780
  /**
@@ -747,7 +790,7 @@ type KeywordSuggestion = {
747
790
  */
748
791
  caseSensitive?: boolean;
749
792
  /**
750
- * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
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).
751
794
  */
752
795
  exactPhrase?: boolean;
753
796
  /**
@@ -755,7 +798,12 @@ type KeywordSuggestion = {
755
798
  */
756
799
  repositories?: {
757
800
  /**
758
- * The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
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.
759
807
  */
760
808
  events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
761
809
  /**
@@ -763,7 +811,7 @@ type KeywordSuggestion = {
763
811
  */
764
812
  minStars?: number | null;
765
813
  /**
766
- * Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
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.
767
815
  */
768
816
  minWeeklyStars?: number | null;
769
817
  };
@@ -790,7 +838,7 @@ type KeywordSuggestion = {
790
838
  */
791
839
  mentions: number;
792
840
  /**
793
- * The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
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.
794
842
  */
795
843
  per?: 'day' | 'week' | 'month';
796
844
  } | null;
@@ -799,14 +847,45 @@ type KeywordSuggestion = {
799
847
  */
800
848
  comments?: {
801
849
  /**
802
- * Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
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).
803
851
  */
804
852
  enabled?: boolean;
805
853
  /**
806
- * The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
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.
807
855
  */
808
856
  maxPerPost?: number;
809
857
  };
858
+ /**
859
+ * Which of this keyword's mentions you see, by language and country; each list is replaced when sent, kept when omitted. Hidden mentions are still billed.
860
+ */
861
+ display?: {
862
+ /**
863
+ * By the language of the post (ISO 639-1); omitted: untouched.
864
+ */
865
+ languages?: {
866
+ /**
867
+ * Replaces the list; [] clears it.
868
+ */
869
+ only?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
870
+ /**
871
+ * Replaces the list; [] clears it.
872
+ */
873
+ excluded?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
874
+ };
875
+ /**
876
+ * By where the author is (ISO 3166-1 alpha-2); omitted: untouched.
877
+ */
878
+ countries?: {
879
+ /**
880
+ * Replaces the list; [] clears it.
881
+ */
882
+ 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'>;
883
+ /**
884
+ * Replaces the list; [] clears it.
885
+ */
886
+ 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'>;
887
+ };
888
+ };
810
889
  /**
811
890
  * Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
812
891
  */
@@ -828,7 +907,7 @@ type KeywordSuggestion = {
828
907
  */
829
908
  id?: string;
830
909
  /**
831
- * App Store and Google Play only: storefronts to read, two-letter codes, at most 20. Default: the one in the link, else us. Each is one more poll a day; the same review seen in two storefronts is one mention. Trustpilot and Google Maps have one page for everyone and take none.
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.
832
911
  */
833
912
  countries?: Array<string>;
834
913
  /**
@@ -930,7 +1009,14 @@ type KeywordHealth = {
930
1009
  days: number;
931
1010
  };
932
1011
  /**
933
- * healthy: nothing to fix. noisy: 20 or more scored matches in the window and under 30% of them relevant. quiet: 7 days or older with no relevant match in the window. capped: at its monthly mention cap. paused: muted (by you, the wallet or the noise brake). new: under 7 days old and not noisy yet, or changed in the last 7 days with under 20 scored matches since the change. When the keyword's matching rules, platforms or context changed (or it was unmuted) inside the window, the status reads only the matches since then (stats.judgedSince).
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.
934
1020
  */
935
1021
  status: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
936
1022
  /**
@@ -966,7 +1052,7 @@ type KeywordHealth = {
966
1052
  */
967
1053
  workspaceShare: number | null;
968
1054
  /**
969
- * When the keyword last changed its matching rules, platforms or context (or was unmuted), when that is inside the window: the status, the reasons, noiseTerms, noiseAuthors and suggestions read only the matches since then, while these numbers keep the whole window. Null: everything reads the whole window.
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.
970
1056
  */
971
1057
  judgedSince: string | null;
972
1058
  /**
@@ -974,9 +1060,9 @@ type KeywordHealth = {
974
1060
  */
975
1061
  byPlatform: Array<{
976
1062
  /**
977
- * 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).
978
1064
  */
979
- 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';
980
1066
  /**
981
1067
  * Matches on this platform in the window.
982
1068
  */
@@ -1139,7 +1225,7 @@ type Feed = {
1139
1225
  */
1140
1226
  connectedAt: string;
1141
1227
  /**
1142
- * Nothing published before this is a live mention: the connection, or the last time its sign-in was added or removed (signed in and signed out, a post is read as two different posts, so the switch starts over rather than bill one twice).
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).
1143
1229
  */
1144
1230
  readingSince: string;
1145
1231
  /**
@@ -1269,11 +1355,11 @@ type Mention = {
1269
1355
  };
1270
1356
  post: {
1271
1357
  /**
1272
- * 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).
1273
1359
  */
1274
- 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';
1275
1361
  /**
1276
- * post: a top-level post. comment: an item that answers a post or another comment (a Reddit or Hacker News comment, an X or Bluesky reply, a Stack Overflow answer, a YouTube comment). repository: an event about a GitHub repository naming the keyword (see post.repository).
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).
1277
1363
  */
1278
1364
  kind: 'post' | 'comment' | 'repository';
1279
1365
  /**
@@ -1285,7 +1371,7 @@ type Mention = {
1285
1371
  */
1286
1372
  text: string;
1287
1373
  /**
1288
- * The post's own title where the platform has one: a Hacker News story, a Reddit thread, a GitHub issue or pull request, a Stack Overflow question, a DEV article, a YouTube video, a news article, a titled review. Null for platforms without titles (X, Bluesky, LinkedIn) and for posts ingested before October 2026.
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.
1289
1375
  */
1290
1376
  title: string | null;
1291
1377
  /**
@@ -1309,7 +1395,13 @@ type Mention = {
1309
1395
  */
1310
1396
  name: string;
1311
1397
  /**
1312
- * What happened. new: it was created. traction: under 30 days old, it reached 10 stars. stars: it passed a star milestone. growth: it gained stars fast in a week. top: one of the most starred repositories naming the keyword, brought by a new keyword's look-back.
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.
1313
1405
  */
1314
1406
  event: 'new' | 'traction' | 'stars' | 'growth' | 'top';
1315
1407
  /**
@@ -1330,7 +1422,7 @@ type Mention = {
1330
1422
  */
1331
1423
  publishedAt: string;
1332
1424
  /**
1333
- * Engagement counts as the platform reported them when the post was ingested, usually minutes after it was written; a count the platform does not have is null. Null as a whole for platforms that report none and for posts ingested before September 2026. X carries all six.
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.
1334
1426
  */
1335
1427
  engagement: {
1336
1428
  likes: number | null;
@@ -1462,19 +1554,26 @@ type Mention = {
1462
1554
  */
1463
1555
  sentiment: 'positive' | 'neutral' | 'negative';
1464
1556
  /**
1465
- * Intent and topic tags: buy_intent, question, complaint, praise, comparison, churn_intent (leaving or replacing the keyword), bug_report, pricing, hiring, event, promotional, testimonial (a customer vouching for it from their own use), industry_insight (analysis or data about the field), launch (a product or feature launch announcement), feedback (a suggestion or request about it).
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.
1466
1565
  */
1467
1566
  intents: Array<string>;
1468
1567
  /**
1469
- * The post reads as machine-made: a bot or app account, a scheduled or templated post, an obvious AI-written summary. A label only: automated mentions stay in the feed, are delivered as usual and are billed like any other match. false while unjudged.
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.
1470
1569
  */
1471
1570
  automated: boolean;
1472
1571
  /**
1473
- * The language the post is written in, as an ISO 639-1 code (en, es, de); null when unknown or classified before languages were recorded.
1572
+ * The language the post is written in, as an ISO 639-1 code (en, es, de); null when unknown, not one of the 20 the classifier names, or classified before languages were recorded.
1474
1573
  */
1475
1574
  language: string | null;
1476
1575
  /**
1477
- * Where the author is, as a lowercase ISO 3166-1 alpha-2 code (us, in, de): the classifier's reading of the author's profile location and the post. A best guess, not a fact the platform gave; null when nothing tells, or classified before countries were recorded.
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.
1478
1577
  */
1479
1578
  country: string | null;
1480
1579
  /**
@@ -1547,7 +1646,7 @@ type Mention = {
1547
1646
  note: string | null;
1548
1647
  };
1549
1648
  /**
1550
- * Set on a cross-post: the id of the mention this one copies (the same author posting the same text again for the same keyword within three days, like one announcement pasted into five subreddits). A copy is billed like any mention but is listed only under its original and never alerted on its own. null for an original.
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).
1551
1650
  */
1552
1651
  duplicateOf: string | null;
1553
1652
  /**
@@ -1559,9 +1658,9 @@ type Mention = {
1559
1658
  */
1560
1659
  id: string;
1561
1660
  /**
1562
- * 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).
1563
1662
  */
1564
- 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';
1565
1664
  /**
1566
1665
  * Link to the copy.
1567
1666
  */
@@ -1624,7 +1723,7 @@ type MentionComment = {
1624
1723
  */
1625
1724
  parentCommentId: string | null;
1626
1725
  /**
1627
- * Engagement counts as the platform reported them when the post was ingested, usually minutes after it was written; a count the platform does not have is null. Null as a whole for platforms that report none and for posts ingested before September 2026. X carries all six.
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.
1628
1727
  */
1629
1728
  engagement: {
1630
1729
  likes: number | null;
@@ -1660,7 +1759,7 @@ type Person = {
1660
1759
  /**
1661
1760
  * Platform of the canonical account; `accounts` lists every account.
1662
1761
  */
1663
- 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';
1664
1763
  /**
1665
1764
  * Display name as of their newest post; null when the platform has none.
1666
1765
  */
@@ -1683,9 +1782,9 @@ type Person = {
1683
1782
  */
1684
1783
  id: string;
1685
1784
  /**
1686
- * 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).
1687
1786
  */
1688
- 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';
1689
1788
  /**
1690
1789
  * Display name as the platform reports it.
1691
1790
  */
@@ -1830,6 +1929,97 @@ type PersonActivity = {
1830
1929
  */
1831
1930
  createdAt: string;
1832
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
+ };
1833
2023
  type Segment = {
1834
2024
  /**
1835
2025
  * Segment id (seg_...).
@@ -1841,7 +2031,7 @@ type Segment = {
1841
2031
  /**
1842
2032
  * People with an account on any of these platforms.
1843
2033
  */
1844
- 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'>;
1845
2035
  /**
1846
2036
  * People carrying any of these tags.
1847
2037
  */
@@ -1877,7 +2067,7 @@ type Segment = {
1877
2067
  /**
1878
2068
  * Nobody with an account on these platforms.
1879
2069
  */
1880
- 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'>;
1881
2071
  /**
1882
2072
  * Nobody carrying any of these tags.
1883
2073
  */
@@ -1959,11 +2149,11 @@ type FilterGroup = {
1959
2149
  /**
1960
2150
  * Only posts from any of these platforms.
1961
2151
  */
1962
- 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'>;
1963
2153
  /**
1964
2154
  * Never posts from these platforms.
1965
2155
  */
1966
- 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'>;
1967
2157
  /**
1968
2158
  * Only mentions in this status: open, ignored, done.
1969
2159
  */
@@ -2063,6 +2253,10 @@ type FilterGroup = {
2063
2253
  /**
2064
2254
  * Never these authors: display names, handles or profile URLs.
2065
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
+ */
2066
2260
  excludeAuthors?: Array<string>;
2067
2261
  /**
2068
2262
  * Only app store reviews with any of these star ratings; every other post fails it.
@@ -2132,11 +2326,11 @@ type View = {
2132
2326
  /**
2133
2327
  * Only posts from any of these platforms.
2134
2328
  */
2135
- 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'>;
2136
2330
  /**
2137
2331
  * Never posts from these platforms.
2138
2332
  */
2139
- 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'>;
2140
2334
  /**
2141
2335
  * Only mentions in this status: open, ignored, done.
2142
2336
  */
@@ -2236,6 +2430,10 @@ type View = {
2236
2430
  /**
2237
2431
  * Never these authors: display names, handles or profile URLs.
2238
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
+ */
2239
2437
  excludeAuthors?: Array<string>;
2240
2438
  /**
2241
2439
  * Only app store reviews with any of these star ratings; every other post fails it.
@@ -2270,7 +2468,7 @@ type View = {
2270
2468
  */
2271
2469
  minBookmarks?: number;
2272
2470
  /**
2273
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
2274
2472
  */
2275
2473
  anyOf?: Array<FilterGroup>;
2276
2474
  };
@@ -2550,7 +2748,12 @@ type FeedFailingEventData = {
2550
2748
  title: string | null;
2551
2749
  };
2552
2750
  /**
2553
- * login_required: the feed answers a sign-in or access-denied page (connect it with the forum's sign-in, auth). login_expired: the same on a feed that has a sign-in: copy a fresh cookie. blocked: a 403, a 429 or a bot check. not_found: the feed is gone. not_a_feed: the address answers a page, not RSS or Atom. unreachable: no answer or a server error.
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.
2554
2757
  */
2555
2758
  reason: 'login_required' | 'login_expired' | 'blocked' | 'not_found' | 'not_a_feed' | 'unreachable';
2556
2759
  /**
@@ -2572,7 +2775,12 @@ type AttentionItem = {
2572
2775
  */
2573
2776
  id: string;
2574
2777
  /**
2575
- * mention.spike: far more mentions in the last hour than the keyword usually gets. sentiment.negative_spike: the negative share of the last 24 hours jumped. keyword.noisy: most scored matches are noise. channel.failing: the channel's last sends all failed. feed.failing: a workspace feed failed its last 3 hourly reads. feed.recovered: it read again after failing.
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.
2576
2784
  */
2577
2785
  kind: 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered';
2578
2786
  /**
@@ -2933,7 +3141,7 @@ type UsageBreakdown = {
2933
3141
  */
2934
3142
  billableMentions: number;
2935
3143
  /**
2936
- * Matches recorded in the window that are never charged: no score yet (still being scored, or classification failed), or a free review from the look-back of a newly connected app. Every other match is charged, on the mentions line or, for a comment, on the comments line.
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.
2937
3145
  */
2938
3146
  unclassifiedMentions: number;
2939
3147
  /**
@@ -2953,11 +3161,11 @@ type UsageBreakdown = {
2953
3161
  */
2954
3162
  totalCents: number;
2955
3163
  /**
2956
- * What the ledger has debited so far for the days of the window, each debit by the day it settled, for the whole workspace whatever the filters. Mentions settle the morning after their day, so a window ending today lags totalCents by today's mentions (and yesterday's before the tick at 00:05 UTC); a closed month differs from totalCents only by cumulative rounding.
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).
2957
3165
  */
2958
3166
  ledgerDebitCents: number;
2959
3167
  /**
2960
- * Billed mentions whose match row is gone (deleted keyword), so no platform or keyword row can claim them. Charged all the same. Comments carry their keyword and platform on the billed row, so they are never unattributed (by=group puts a deleted keyword's comments on the no-group row).
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).
2961
3169
  */
2962
3170
  unattributedBillable: number;
2963
3171
  };
@@ -3008,7 +3216,7 @@ type UsageBreakdown = {
3008
3216
  removed: boolean;
3009
3217
  } | null;
3010
3218
  /**
3011
- * Keyword-days metered in this group: the days the daily tick charged for. Null for by=platform (a keyword-day belongs to no platform) and for a day before the first recorded tick (unknown, not zero); a keyword row counts only the days on record, so before window.keywordDaysFrom it is a floor, not a zero.
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.
3012
3220
  */
3013
3221
  keywordDays: number | null;
3014
3222
  /**
@@ -3024,7 +3232,7 @@ type UsageBreakdown = {
3024
3232
  */
3025
3233
  billableMentions: number;
3026
3234
  /**
3027
- * Matches recorded in the window that are never charged: no score yet (still being scored, or classification failed), or a free review from the look-back of a newly connected app. Every other match is charged, on the mentions line or, for a comment, on the comments line.
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.
3028
3236
  */
3029
3237
  unclassifiedMentions: number;
3030
3238
  /**
@@ -3252,7 +3460,12 @@ type Alert = {
3252
3460
  name: string;
3253
3461
  enabled: boolean;
3254
3462
  /**
3255
- * instant: each matching mention as it happens. hourly: one digest each UTC hour (five minutes past, so the last mentions of the hour are scored) covering the previous full hour, nothing when that hour has no mention at or over the rule's relevance floor; Slack, Telegram and webhook channels only. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
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.
3256
3469
  */
3257
3470
  mode: 'instant' | 'hourly' | 'daily' | 'weekly';
3258
3471
  filter: {
@@ -3267,9 +3480,9 @@ type Alert = {
3267
3480
  /**
3268
3481
  * Only posts from these platforms.
3269
3482
  */
3270
- 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'>;
3271
3484
  /**
3272
- * The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
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.
3273
3486
  */
3274
3487
  minRelevance?: number;
3275
3488
  /**
@@ -3353,7 +3566,7 @@ type Alert = {
3353
3566
  */
3354
3567
  minBookmarks?: number;
3355
3568
  /**
3356
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
3357
3570
  */
3358
3571
  anyOf?: Array<FilterGroup>;
3359
3572
  };
@@ -3830,9 +4043,9 @@ type AnalyticsBreakdown = {
3830
4043
  */
3831
4044
  name: string | null;
3832
4045
  /**
3833
- * 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).
3834
4047
  */
3835
- 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';
3836
4049
  /**
3837
4050
  * Profile URL.
3838
4051
  */
@@ -4429,19 +4642,59 @@ type ListKeywordsData = {
4429
4642
  /**
4430
4643
  * Only keywords in any of these groups (grp_...). Repeatable, or comma-separated.
4431
4644
  */
4432
- groupId?: Array<string> | null;
4645
+ groupIds?: Array<string> | null;
4646
+ /**
4647
+ * Never keywords in these groups (grp_...). Repeatable, or comma-separated.
4648
+ */
4649
+ notGroupIds?: Array<string> | null;
4433
4650
  /**
4434
4651
  * Only these kinds: brand, competitor, topic. Repeatable, or comma-separated.
4435
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
+ */
4436
4685
  kind?: Array<'brand' | 'competitor' | 'topic'>;
4437
4686
  /**
4438
- * Only keywords in these states: active, muted, paused, capped. Repeatable, or comma-separated.
4687
+ * Deprecated: use statuses, the same filter; both are read as one list.
4688
+ *
4689
+ * @deprecated
4439
4690
  */
4440
4691
  status?: Array<'active' | 'muted' | 'paused' | 'noisy' | 'capped'>;
4441
4692
  /**
4442
- * 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.
4693
+ * Deprecated: use platforms, the same filter; both are read as one list.
4694
+ *
4695
+ * @deprecated
4443
4696
  */
4444
- 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'>;
4445
4698
  /**
4446
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.
4447
4700
  */
@@ -4489,7 +4742,7 @@ type ListKeywordsResponses = {
4489
4742
  */
4490
4743
  pausedForBalance: boolean;
4491
4744
  /**
4492
- * Muted by the noise brake: on a workspace running on its welcome credit, at least 20 of its matches were scored and under 30% were relevant. A change of its required or excluded terms, platforms or context resumes it (when the balance covers another day), and so does unmuting; a top-up does not.
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).
4493
4746
  */
4494
4747
  pausedForNoise: boolean;
4495
4748
  /**
@@ -4505,7 +4758,7 @@ type ListKeywordsResponses = {
4505
4758
  */
4506
4759
  mentions: number;
4507
4760
  /**
4508
- * The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
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.
4509
4762
  */
4510
4763
  per?: 'day' | 'week' | 'month';
4511
4764
  /**
@@ -4530,23 +4783,54 @@ type ListKeywordsResponses = {
4530
4783
  resumesAt: string | null;
4531
4784
  } | null;
4532
4785
  /**
4533
- * Comments under this keyword's mentions: when enabled, the comments of every mention scored relevant are read from 30 minutes after the post, on a schedule per platform (for a day on Reddit, Hacker News and Bluesky, a week on GitHub, Stack Overflow and DEV, a month on YouTube) (new comments only, at most maxPerPost a thread, comments of fewer than three words dropped), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments.
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).
4534
4787
  */
4535
4788
  comments: {
4536
4789
  /**
4537
- * Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
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).
4538
4791
  */
4539
4792
  enabled: boolean;
4540
4793
  /**
4541
- * The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
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.
4542
4795
  */
4543
4796
  maxPerPost: number;
4544
4797
  };
4798
+ /**
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).
4800
+ */
4801
+ display: {
4802
+ /**
4803
+ * By the language the post is written in (ISO 639-1).
4804
+ */
4805
+ languages: {
4806
+ /**
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.
4808
+ */
4809
+ only: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
4810
+ /**
4811
+ * A post whose language is listed is hidden.
4812
+ */
4813
+ excluded: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
4814
+ };
4815
+ /**
4816
+ * By where the author is (ISO 3166-1 alpha-2), as the classifier read their profile and the post.
4817
+ */
4818
+ countries: {
4819
+ /**
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.
4821
+ */
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'>;
4823
+ /**
4824
+ * A post whose author's country is listed is hidden.
4825
+ */
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'>;
4827
+ };
4828
+ };
4545
4829
  group: GroupRef;
4546
4830
  /**
4547
4831
  * Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
4548
4832
  */
4549
- 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;
4550
4834
  /**
4551
4835
  * RSS and Atom feeds this keyword reads; empty for none.
4552
4836
  */
@@ -4560,7 +4844,7 @@ type ListKeywordsResponses = {
4560
4844
  */
4561
4845
  reviewSources: Array<ReviewSource>;
4562
4846
  /**
4563
- * A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
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.
4564
4848
  */
4565
4849
  context: string | null;
4566
4850
  /**
@@ -4576,7 +4860,7 @@ type ListKeywordsResponses = {
4576
4860
  */
4577
4861
  requiredMode: 'any' | 'all';
4578
4862
  /**
4579
- * Combinations of terms, at most 50 of 10 terms each: the post must ALSO contain every term of at least one group (an OR of ANDs). For the keyword inreach, [["weather", "alert*"], ["tsunami"], ["flash flood"]] keeps a post about inReach weather alerts, tsunamis or flash floods, one keyword instead of three. Same phrase and wildcard rules as requiredTerms; when both are set a post must pass both. Empty: no 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).
4580
4864
  */
4581
4865
  requiredGroups: Array<Array<string>>;
4582
4866
  /**
@@ -4592,7 +4876,7 @@ type ListKeywordsResponses = {
4592
4876
  */
4593
4877
  caseSensitive: boolean;
4594
4878
  /**
4595
- * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
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).
4596
4880
  */
4597
4881
  exactPhrase: boolean;
4598
4882
  /**
@@ -4613,7 +4897,12 @@ type ListKeywordsResponses = {
4613
4897
  */
4614
4898
  repositories: {
4615
4899
  /**
4616
- * The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
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.
4617
4906
  */
4618
4907
  events: Array<'new' | 'traction' | 'stars' | 'growth'>;
4619
4908
  /**
@@ -4621,7 +4910,7 @@ type ListKeywordsResponses = {
4621
4910
  */
4622
4911
  minStars: number | null;
4623
4912
  /**
4624
- * Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
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.
4625
4914
  */
4626
4915
  minWeeklyStars: number | null;
4627
4916
  };
@@ -4681,11 +4970,18 @@ type ListKeywordsResponses = {
4681
4970
  noisy: boolean;
4682
4971
  };
4683
4972
  /**
4684
- * The keyword's health over the same 14 days as `noise`, by the rule GET /v1/keywords/{id}/health applies to its own window: paused (muted), capped (at its mention cap), noisy (20 or more scored matches, under 30% relevant), new (under 7 days old and not noisy, or changed in the last 7 days with under 20 scored matches since), quiet (7 days or older, nothing relevant), else healthy. Judged on the matches since the keyword's last change to its matching rules, platforms or context (or its unmute) when that is inside the 14 days, so a keyword tightened today is not flagged on the noise the change removed; `noise` itself keeps the whole 14 days. Always 14 days, while the endpoint reads 30 by default, so the two can differ for the same keyword. The health endpoint says why and what to change.
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.
4685
4981
  */
4686
4982
  health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
4687
4983
  /**
4688
- * What this keyword has cost this calendar month (UTC) at list price: exactly its row in GET /v1/usage/breakdown?month=<this month> (same tables, same rounding). The wallet's ledger, which settles once a day, is what can differ from these list-price numbers, and only by cumulative rounding.
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.
4689
4985
  */
4690
4986
  cost: {
4691
4987
  /**
@@ -4723,9 +5019,9 @@ type ListKeywordsResponses = {
4723
5019
  */
4724
5020
  polling: Array<{
4725
5021
  /**
4726
- * 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).
4727
5023
  */
4728
- 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';
4729
5025
  /**
4730
5026
  * Newest poll of this platform for the term; null until the first one.
4731
5027
  */
@@ -4760,9 +5056,9 @@ type CreateKeywordData = {
4760
5056
  /**
4761
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.
4762
5058
  */
4763
- 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;
4764
5060
  /**
4765
- * A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
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.
4766
5062
  */
4767
5063
  context?: string | null;
4768
5064
  /**
@@ -4778,7 +5074,7 @@ type CreateKeywordData = {
4778
5074
  */
4779
5075
  requiredMode?: 'any' | 'all';
4780
5076
  /**
4781
- * Combinations of terms, at most 50 of 10 terms each: the post must ALSO contain every term of at least one group (an OR of ANDs). For the keyword inreach, [["weather", "alert*"], ["tsunami"], ["flash flood"]] keeps a post about inReach weather alerts, tsunamis or flash floods, one keyword instead of three. Same phrase and wildcard rules as requiredTerms; when both are set a post must pass both. Empty: no 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).
4782
5078
  */
4783
5079
  requiredGroups?: Array<Array<string>>;
4784
5080
  /**
@@ -4794,7 +5090,7 @@ type CreateKeywordData = {
4794
5090
  */
4795
5091
  caseSensitive?: boolean;
4796
5092
  /**
4797
- * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
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).
4798
5094
  */
4799
5095
  exactPhrase?: boolean;
4800
5096
  /**
@@ -4802,7 +5098,12 @@ type CreateKeywordData = {
4802
5098
  */
4803
5099
  repositories?: {
4804
5100
  /**
4805
- * The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
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.
4806
5107
  */
4807
5108
  events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
4808
5109
  /**
@@ -4810,7 +5111,7 @@ type CreateKeywordData = {
4810
5111
  */
4811
5112
  minStars?: number | null;
4812
5113
  /**
4813
- * Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
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.
4814
5115
  */
4815
5116
  minWeeklyStars?: number | null;
4816
5117
  };
@@ -4837,7 +5138,7 @@ type CreateKeywordData = {
4837
5138
  */
4838
5139
  mentions: number;
4839
5140
  /**
4840
- * The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
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.
4841
5142
  */
4842
5143
  per?: 'day' | 'week' | 'month';
4843
5144
  } | null;
@@ -4846,20 +5147,51 @@ type CreateKeywordData = {
4846
5147
  */
4847
5148
  comments?: {
4848
5149
  /**
4849
- * Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
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).
4850
5151
  */
4851
5152
  enabled?: boolean;
4852
5153
  /**
4853
- * The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
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.
4854
5155
  */
4855
5156
  maxPerPost?: number;
4856
5157
  };
5158
+ /**
5159
+ * Which of this keyword's mentions you see, by language and country; each list is replaced when sent, kept when omitted. Hidden mentions are still billed.
5160
+ */
5161
+ display?: {
5162
+ /**
5163
+ * By the language of the post (ISO 639-1); omitted: untouched.
5164
+ */
5165
+ languages?: {
5166
+ /**
5167
+ * Replaces the list; [] clears it.
5168
+ */
5169
+ only?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
5170
+ /**
5171
+ * Replaces the list; [] clears it.
5172
+ */
5173
+ excluded?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
5174
+ };
5175
+ /**
5176
+ * By where the author is (ISO 3166-1 alpha-2); omitted: untouched.
5177
+ */
5178
+ countries?: {
5179
+ /**
5180
+ * Replaces the list; [] clears it.
5181
+ */
5182
+ 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'>;
5183
+ /**
5184
+ * Replaces the list; [] clears it.
5185
+ */
5186
+ 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'>;
5187
+ };
5188
+ };
4857
5189
  /**
4858
5190
  * The group to track it in (grp_...); omit for the workspace's default group. A term may be tracked once per group.
4859
5191
  */
4860
5192
  groupId?: string;
4861
5193
  /**
4862
- * Review pages this keyword collects, at most 10: App Store and Google Play apps, Trustpilot pages, Google Maps places. Every new review of one is a mention of the keyword, whatever its text says. Polled once a day (per country on the app stores). A newly connected page brings its last 30 days, the newest 100 reviews (per country), free and never sent as instant alerts; after that each review bills like any mention.
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).
4863
5195
  */
4864
5196
  reviewSources?: Array<{
4865
5197
  /**
@@ -4875,7 +5207,7 @@ type CreateKeywordData = {
4875
5207
  */
4876
5208
  id?: string;
4877
5209
  /**
4878
- * App Store and Google Play only: storefronts to read, two-letter codes, at most 20. Default: the one in the link, else us. Each is one more poll a day; the same review seen in two storefronts is one mention. Trustpilot and Google Maps have one page for everyone and take none.
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.
4879
5211
  */
4880
5212
  countries?: Array<string>;
4881
5213
  /**
@@ -4884,7 +5216,7 @@ type CreateKeywordData = {
4884
5216
  language?: string;
4885
5217
  }>;
4886
5218
  /**
4887
- * RSS or Atom feeds this keyword reads, at most 20, each { url }: a feed's URL, or a page's (a forum, a community, a blog), in which case the feed the page advertises is used, else a usual address such as /feed or /rss. A URL with no feed behind it is a 400. Each feed is read every hour; an item is a mention of this keyword when it holds the term (with the keyword's matching rules), and only of keywords that named the feed. A newly connected feed brings its newest 10 items of the last 30 days that hold the term, billed like any mention and never sent as instant alerts.
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).
4888
5220
  */
4889
5221
  feeds?: Array<{
4890
5222
  /**
@@ -4897,6 +5229,12 @@ type CreateKeywordData = {
4897
5229
  */
4898
5230
  readsWorkspaceFeeds?: boolean;
4899
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
+ };
4900
5238
  path?: never;
4901
5239
  query?: never;
4902
5240
  url: '/v1/keywords';
@@ -4987,7 +5325,7 @@ type UpdateKeywordData = {
4987
5325
  */
4988
5326
  body: {
4989
5327
  /**
4990
- * Renames the keyword: the new term is tracked from now on, with no look-back, and the keyword keeps its id, its settings and the mentions the old term found. Wrap it in double quotes for the exact phrase only. A 409 when its group already tracks the new term.
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.
4991
5329
  */
4992
5330
  term?: string;
4993
5331
  /**
@@ -5001,9 +5339,9 @@ type UpdateKeywordData = {
5001
5339
  /**
5002
5340
  * Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).
5003
5341
  */
5004
- 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;
5005
5343
  /**
5006
- * A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
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.
5007
5345
  */
5008
5346
  context?: string | null;
5009
5347
  /**
@@ -5019,7 +5357,7 @@ type UpdateKeywordData = {
5019
5357
  */
5020
5358
  requiredMode?: 'any' | 'all';
5021
5359
  /**
5022
- * Combinations of terms, at most 50 of 10 terms each: the post must ALSO contain every term of at least one group (an OR of ANDs). For the keyword inreach, [["weather", "alert*"], ["tsunami"], ["flash flood"]] keeps a post about inReach weather alerts, tsunamis or flash floods, one keyword instead of three. Same phrase and wildcard rules as requiredTerms; when both are set a post must pass both. Empty: no 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).
5023
5361
  */
5024
5362
  requiredGroups?: Array<Array<string>>;
5025
5363
  /**
@@ -5035,7 +5373,7 @@ type UpdateKeywordData = {
5035
5373
  */
5036
5374
  caseSensitive?: boolean;
5037
5375
  /**
5038
- * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
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).
5039
5377
  */
5040
5378
  exactPhrase?: boolean;
5041
5379
  /**
@@ -5043,7 +5381,12 @@ type UpdateKeywordData = {
5043
5381
  */
5044
5382
  repositories?: {
5045
5383
  /**
5046
- * The repository events this keyword takes. traction: a repository created in the last 30 days reached 10 stars. stars: one with 100 stars or more passed a milestone (100, 250, 500, 1,000, 2,000, 5,000 ...). growth: it gained stars fast in a week. new: every repository created, even with no stars (off by default: nearly all of them are noise for a broad keyword). Default: traction, stars, growth. Empty: no repository events.
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.
5047
5390
  */
5048
5391
  events?: Array<'new' | 'traction' | 'stars' | 'growth'>;
5049
5392
  /**
@@ -5051,7 +5394,7 @@ type UpdateKeywordData = {
5051
5394
  */
5052
5395
  minStars?: number | null;
5053
5396
  /**
5054
- * Only repositories that gained at least this many stars in the last 7 days (25 or more). It applies to every event, and one whose last week is not known yet does not pass. null: a growth event needs 100 stars and 20% of the repository's stars in a week, the other events need no growth.
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.
5055
5398
  */
5056
5399
  minWeeklyStars?: number | null;
5057
5400
  };
@@ -5078,7 +5421,7 @@ type UpdateKeywordData = {
5078
5421
  */
5079
5422
  mentions: number;
5080
5423
  /**
5081
- * The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
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.
5082
5425
  */
5083
5426
  per?: 'day' | 'week' | 'month';
5084
5427
  } | null;
@@ -5087,14 +5430,45 @@ type UpdateKeywordData = {
5087
5430
  */
5088
5431
  comments?: {
5089
5432
  /**
5090
- * Read the comments under this keyword's relevant mentions, from 30 minutes after each post, as long as its platform's conversations last (a day to a month). Each comment delivered costs $0.008 (comments of fewer than three words are dropped, never billed) (the comments line of the bill). Off by default.
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).
5091
5434
  */
5092
5435
  enabled?: boolean;
5093
5436
  /**
5094
- * The newest comments of one thread you receive, 20 by default, 100 at most: the ceiling on what one mention's comments can cost. A comment that names the keyword is a mention too, but only among these newest ones, so it is never billed past the ceiling.
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.
5095
5438
  */
5096
5439
  maxPerPost?: number;
5097
5440
  };
5441
+ /**
5442
+ * Which of this keyword's mentions you see, by language and country; each list is replaced when sent, kept when omitted. Hidden mentions are still billed.
5443
+ */
5444
+ display?: {
5445
+ /**
5446
+ * By the language of the post (ISO 639-1); omitted: untouched.
5447
+ */
5448
+ languages?: {
5449
+ /**
5450
+ * Replaces the list; [] clears it.
5451
+ */
5452
+ only?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
5453
+ /**
5454
+ * Replaces the list; [] clears it.
5455
+ */
5456
+ excluded?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
5457
+ };
5458
+ /**
5459
+ * By where the author is (ISO 3166-1 alpha-2); omitted: untouched.
5460
+ */
5461
+ countries?: {
5462
+ /**
5463
+ * Replaces the list; [] clears it.
5464
+ */
5465
+ 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'>;
5466
+ /**
5467
+ * Replaces the list; [] clears it.
5468
+ */
5469
+ 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'>;
5470
+ };
5471
+ };
5098
5472
  /**
5099
5473
  * Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
5100
5474
  */
@@ -5116,7 +5490,7 @@ type UpdateKeywordData = {
5116
5490
  */
5117
5491
  id?: string;
5118
5492
  /**
5119
- * App Store and Google Play only: storefronts to read, two-letter codes, at most 20. Default: the one in the link, else us. Each is one more poll a day; the same review seen in two storefronts is one mention. Trustpilot and Google Maps have one page for everyone and take none.
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.
5120
5494
  */
5121
5495
  countries?: Array<string>;
5122
5496
  /**
@@ -5234,6 +5608,12 @@ type DuplicateKeywordData = {
5234
5608
  */
5235
5609
  include?: Array<'reviewSources' | 'feeds'>;
5236
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
+ };
5237
5617
  path: {
5238
5618
  /**
5239
5619
  * Keyword id (kw_...).
@@ -5321,7 +5701,7 @@ type ListFeedsResponses = {
5321
5701
  */
5322
5702
  connectedAt: string;
5323
5703
  /**
5324
- * Nothing published before this is a live mention: the connection, or the last time its sign-in was added or removed (signed in and signed out, a post is read as two different posts, so the switch starts over rather than bill one twice).
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).
5325
5705
  */
5326
5706
  readingSince: string;
5327
5707
  /**
@@ -5409,6 +5789,12 @@ type CreateFeedData = {
5409
5789
  value: string;
5410
5790
  };
5411
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
+ };
5412
5798
  path?: never;
5413
5799
  query?: never;
5414
5800
  url: '/v1/feeds';
@@ -5532,7 +5918,7 @@ type ImportFeedsResponses = {
5532
5918
  */
5533
5919
  connectedAt: string;
5534
5920
  /**
5535
- * Nothing published before this is a live mention: the connection, or the last time its sign-in was added or removed (signed in and signed out, a post is read as two different posts, so the switch starts over rather than bill one twice).
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).
5536
5922
  */
5537
5923
  readingSince: string;
5538
5924
  /**
@@ -5588,7 +5974,7 @@ type ImportFeedsResponses = {
5588
5974
  */
5589
5975
  error: {
5590
5976
  /**
5591
- * The same code POST /v1/feeds answers for this address: feed_login_required (send it again with auth), feed_login_expired (a fresh cookie), feed_unreadable (no feed, or the site blocks readers), feed_limit_reached, feed_auth_not_configured, validation_error (an address that is not one), internal_error (ours: send it again).
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).
5592
5978
  */
5593
5979
  code: 'feed_login_required' | 'feed_login_expired' | 'feed_unreadable' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'validation_error' | 'internal_error';
5594
5980
  /**
@@ -5855,7 +6241,7 @@ type UpdateMentionData = {
5855
6241
  */
5856
6242
  note?: string | null;
5857
6243
  /**
5858
- * Your verdict on relevance, correcting the classifier: true sets relevance to 100 and puts a filtered mention back in the relevant feed, false sets it to 0 and takes it out; null withdraws the verdict and restores the classifier's score. Never billed or unbilled. A mention still being classified answers 409 classification_pending.
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.
5859
6245
  */
5860
6246
  relevant?: boolean | null;
5861
6247
  /**
@@ -5903,13 +6289,17 @@ type SearchMentionsData = {
5903
6289
  path?: never;
5904
6290
  query?: {
5905
6291
  /**
5906
- * Only matches of this keyword.
6292
+ * Deprecated: use keywordIds. Only matches of this keyword; combines with keywordIds as either.
6293
+ *
6294
+ * @deprecated
5907
6295
  */
5908
6296
  keywordId?: string;
5909
6297
  /**
5910
- * Only posts from this platform.
6298
+ * Deprecated: use platforms. Only posts from this platform; combines with platforms as either.
6299
+ *
6300
+ * @deprecated
5911
6301
  */
5912
- 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';
5913
6303
  /**
5914
6304
  * Only mentions in this status. Omit for every status.
5915
6305
  */
@@ -5919,11 +6309,15 @@ type SearchMentionsData = {
5919
6309
  */
5920
6310
  relevant?: boolean;
5921
6311
  /**
5922
- * Only this sentiment.
6312
+ * Deprecated: use sentiments. Only this sentiment; combines with sentiments as either.
6313
+ *
6314
+ * @deprecated
5923
6315
  */
5924
6316
  sentiment?: 'positive' | 'neutral' | 'negative';
5925
6317
  /**
5926
- * 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
5927
6321
  */
5928
6322
  intent?: string;
5929
6323
  /**
@@ -5942,6 +6336,10 @@ type SearchMentionsData = {
5942
6336
  * true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
5943
6337
  */
5944
6338
  includeMuted?: boolean;
6339
+ /**
6340
+ * true: include mentions their keyword's display lists hide (a language or country it does not show), hidden by default.
6341
+ */
6342
+ includeHidden?: boolean;
5945
6343
  /**
5946
6344
  * true: list cross-posts (a mention whose duplicateOf is set) as mentions of their own. By default each is listed only in its original's duplicates.
5947
6345
  */
@@ -5957,6 +6355,12 @@ type SearchMentionsData = {
5957
6355
  /**
5958
6356
  * Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
5959
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
+ */
5960
6364
  excludeAuthors?: Array<string> | null;
5961
6365
  /**
5962
6366
  * Only mentions scored at least this; unclassified ones are excluded.
@@ -6005,11 +6409,11 @@ type SearchMentionsData = {
6005
6409
  /**
6006
6410
  * Only posts from any of these platforms.
6007
6411
  */
6008
- 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'>;
6009
6413
  /**
6010
6414
  * Never posts from these platforms.
6011
6415
  */
6012
- 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'>;
6013
6417
  /**
6014
6418
  * Only matches of any of these keywords.
6015
6419
  */
@@ -6107,7 +6511,7 @@ type SearchMentionsData = {
6107
6511
  */
6108
6512
  minBookmarks?: number | null;
6109
6513
  /**
6110
- * OR across groups of conditions, as URL-encoded JSON: [{"platforms":["reddit"],"sentiments":["negative"]},{"intents":["buy_intent"]}] is "negative on Reddit, or buying intent anywhere". Each group holds the conditions of a view filter (lists any-of, not lists none-of, all ANDed); a mention passes when at least one group holds, and every other filter here still applies. 1 to 10 groups, none empty, no nesting.
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).
6111
6515
  */
6112
6516
  anyOf?: string;
6113
6517
  /**
@@ -6115,11 +6519,31 @@ type SearchMentionsData = {
6115
6519
  */
6116
6520
  q?: string;
6117
6521
  /**
6118
- * Only posts published at or after this instant (ISO 8601, or epoch ms).
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
6119
6541
  */
6120
6542
  since?: string;
6121
6543
  /**
6122
- * 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
6123
6547
  */
6124
6548
  until?: string;
6125
6549
  /**
@@ -6131,7 +6555,7 @@ type SearchMentionsData = {
6131
6555
  */
6132
6556
  cursor?: string;
6133
6557
  /**
6134
- * Page size, 1 to 100.
6558
+ * Page size, 1 to 100 (default 50).
6135
6559
  */
6136
6560
  limit?: number;
6137
6561
  };
@@ -6166,13 +6590,17 @@ type ExportMentionsCsvData = {
6166
6590
  path?: never;
6167
6591
  query?: {
6168
6592
  /**
6169
- * Only matches of this keyword.
6593
+ * Deprecated: use keywordIds. Only matches of this keyword; combines with keywordIds as either.
6594
+ *
6595
+ * @deprecated
6170
6596
  */
6171
6597
  keywordId?: string;
6172
6598
  /**
6173
- * Only posts from this platform.
6599
+ * Deprecated: use platforms. Only posts from this platform; combines with platforms as either.
6600
+ *
6601
+ * @deprecated
6174
6602
  */
6175
- 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';
6176
6604
  /**
6177
6605
  * Only mentions in this status. Omit for every status.
6178
6606
  */
@@ -6182,11 +6610,15 @@ type ExportMentionsCsvData = {
6182
6610
  */
6183
6611
  relevant?: boolean;
6184
6612
  /**
6185
- * Only this sentiment.
6613
+ * Deprecated: use sentiments. Only this sentiment; combines with sentiments as either.
6614
+ *
6615
+ * @deprecated
6186
6616
  */
6187
6617
  sentiment?: 'positive' | 'neutral' | 'negative';
6188
6618
  /**
6189
- * 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
6190
6622
  */
6191
6623
  intent?: string;
6192
6624
  /**
@@ -6205,6 +6637,10 @@ type ExportMentionsCsvData = {
6205
6637
  * true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
6206
6638
  */
6207
6639
  includeMuted?: boolean;
6640
+ /**
6641
+ * true: include mentions their keyword's display lists hide (a language or country it does not show), hidden by default.
6642
+ */
6643
+ includeHidden?: boolean;
6208
6644
  /**
6209
6645
  * true: list cross-posts (a mention whose duplicateOf is set) as mentions of their own. By default each is listed only in its original's duplicates.
6210
6646
  */
@@ -6220,6 +6656,12 @@ type ExportMentionsCsvData = {
6220
6656
  /**
6221
6657
  * Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
6222
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
+ */
6223
6665
  excludeAuthors?: Array<string> | null;
6224
6666
  /**
6225
6667
  * Only mentions scored at least this; unclassified ones are excluded.
@@ -6268,11 +6710,11 @@ type ExportMentionsCsvData = {
6268
6710
  /**
6269
6711
  * Only posts from any of these platforms.
6270
6712
  */
6271
- 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'>;
6272
6714
  /**
6273
6715
  * Never posts from these platforms.
6274
6716
  */
6275
- 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'>;
6276
6718
  /**
6277
6719
  * Only matches of any of these keywords.
6278
6720
  */
@@ -6370,7 +6812,7 @@ type ExportMentionsCsvData = {
6370
6812
  */
6371
6813
  minBookmarks?: number | null;
6372
6814
  /**
6373
- * OR across groups of conditions, as URL-encoded JSON: [{"platforms":["reddit"],"sentiments":["negative"]},{"intents":["buy_intent"]}] is "negative on Reddit, or buying intent anywhere". Each group holds the conditions of a view filter (lists any-of, not lists none-of, all ANDed); a mention passes when at least one group holds, and every other filter here still applies. 1 to 10 groups, none empty, no nesting.
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).
6374
6816
  */
6375
6817
  anyOf?: string;
6376
6818
  /**
@@ -6378,11 +6820,31 @@ type ExportMentionsCsvData = {
6378
6820
  */
6379
6821
  q?: string;
6380
6822
  /**
6381
- * Only posts published at or after this instant (ISO 8601, or epoch ms).
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
6382
6842
  */
6383
6843
  since?: string;
6384
6844
  /**
6385
- * 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
6386
6848
  */
6387
6849
  until?: string;
6388
6850
  };
@@ -6463,13 +6925,17 @@ type ExportMentionsJsonData = {
6463
6925
  path?: never;
6464
6926
  query?: {
6465
6927
  /**
6466
- * Only matches of this keyword.
6928
+ * Deprecated: use keywordIds. Only matches of this keyword; combines with keywordIds as either.
6929
+ *
6930
+ * @deprecated
6467
6931
  */
6468
6932
  keywordId?: string;
6469
6933
  /**
6470
- * Only posts from this platform.
6934
+ * Deprecated: use platforms. Only posts from this platform; combines with platforms as either.
6935
+ *
6936
+ * @deprecated
6471
6937
  */
6472
- 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';
6473
6939
  /**
6474
6940
  * Only mentions in this status. Omit for every status.
6475
6941
  */
@@ -6479,11 +6945,15 @@ type ExportMentionsJsonData = {
6479
6945
  */
6480
6946
  relevant?: boolean;
6481
6947
  /**
6482
- * Only this sentiment.
6948
+ * Deprecated: use sentiments. Only this sentiment; combines with sentiments as either.
6949
+ *
6950
+ * @deprecated
6483
6951
  */
6484
6952
  sentiment?: 'positive' | 'neutral' | 'negative';
6485
6953
  /**
6486
- * 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
6487
6957
  */
6488
6958
  intent?: string;
6489
6959
  /**
@@ -6502,6 +6972,10 @@ type ExportMentionsJsonData = {
6502
6972
  * true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
6503
6973
  */
6504
6974
  includeMuted?: boolean;
6975
+ /**
6976
+ * true: include mentions their keyword's display lists hide (a language or country it does not show), hidden by default.
6977
+ */
6978
+ includeHidden?: boolean;
6505
6979
  /**
6506
6980
  * true: list cross-posts (a mention whose duplicateOf is set) as mentions of their own. By default each is listed only in its original's duplicates.
6507
6981
  */
@@ -6517,6 +6991,12 @@ type ExportMentionsJsonData = {
6517
6991
  /**
6518
6992
  * Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
6519
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
+ */
6520
7000
  excludeAuthors?: Array<string> | null;
6521
7001
  /**
6522
7002
  * Only mentions scored at least this; unclassified ones are excluded.
@@ -6565,11 +7045,11 @@ type ExportMentionsJsonData = {
6565
7045
  /**
6566
7046
  * Only posts from any of these platforms.
6567
7047
  */
6568
- 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'>;
6569
7049
  /**
6570
7050
  * Never posts from these platforms.
6571
7051
  */
6572
- 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'>;
6573
7053
  /**
6574
7054
  * Only matches of any of these keywords.
6575
7055
  */
@@ -6667,7 +7147,7 @@ type ExportMentionsJsonData = {
6667
7147
  */
6668
7148
  minBookmarks?: number | null;
6669
7149
  /**
6670
- * OR across groups of conditions, as URL-encoded JSON: [{"platforms":["reddit"],"sentiments":["negative"]},{"intents":["buy_intent"]}] is "negative on Reddit, or buying intent anywhere". Each group holds the conditions of a view filter (lists any-of, not lists none-of, all ANDed); a mention passes when at least one group holds, and every other filter here still applies. 1 to 10 groups, none empty, no nesting.
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).
6671
7151
  */
6672
7152
  anyOf?: string;
6673
7153
  /**
@@ -6675,11 +7155,31 @@ type ExportMentionsJsonData = {
6675
7155
  */
6676
7156
  q?: string;
6677
7157
  /**
6678
- * Only posts published at or after this instant (ISO 8601, or epoch ms).
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
6679
7177
  */
6680
7178
  since?: string;
6681
7179
  /**
6682
- * 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
6683
7183
  */
6684
7184
  until?: string;
6685
7185
  };
@@ -6725,9 +7225,11 @@ type ExportPeopleCsvData = {
6725
7225
  */
6726
7226
  groupId?: string;
6727
7227
  /**
6728
- * 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
6729
7231
  */
6730
- 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';
6731
7233
  /**
6732
7234
  * Matches the display name or the profile handle or URL, case-insensitively.
6733
7235
  */
@@ -6737,7 +7239,9 @@ type ExportPeopleCsvData = {
6737
7239
  */
6738
7240
  handle?: string;
6739
7241
  /**
6740
- * 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
6741
7245
  */
6742
7246
  tag?: string;
6743
7247
  /**
@@ -6745,7 +7249,25 @@ type ExportPeopleCsvData = {
6745
7249
  */
6746
7250
  muted?: boolean;
6747
7251
  /**
6748
- * Only people whose first matched mention is at or after this instant (ISO 8601, or epoch ms).
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
6749
7271
  */
6750
7272
  since?: string;
6751
7273
  /**
@@ -6755,7 +7277,7 @@ type ExportPeopleCsvData = {
6755
7277
  /**
6756
7278
  * People with an account on any of these platforms. Repeatable, or comma-separated.
6757
7279
  */
6758
- 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'>;
6759
7281
  /**
6760
7282
  * People carrying any of these tags. Repeatable, or comma-separated.
6761
7283
  */
@@ -6783,7 +7305,7 @@ type ExportPeopleCsvData = {
6783
7305
  /**
6784
7306
  * Nobody with an account on these platforms. Repeatable, or comma-separated.
6785
7307
  */
6786
- 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'>;
6787
7309
  /**
6788
7310
  * Nobody carrying any of these tags. Repeatable, or comma-separated.
6789
7311
  */
@@ -6862,9 +7384,11 @@ type ListPeopleData = {
6862
7384
  */
6863
7385
  groupId?: string;
6864
7386
  /**
6865
- * 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
6866
7390
  */
6867
- 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';
6868
7392
  /**
6869
7393
  * Matches the display name or the profile handle or URL, case-insensitively.
6870
7394
  */
@@ -6874,7 +7398,9 @@ type ListPeopleData = {
6874
7398
  */
6875
7399
  handle?: string;
6876
7400
  /**
6877
- * 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
6878
7404
  */
6879
7405
  tag?: string;
6880
7406
  /**
@@ -6882,7 +7408,25 @@ type ListPeopleData = {
6882
7408
  */
6883
7409
  muted?: boolean;
6884
7410
  /**
6885
- * Only people whose first matched mention is at or after this instant (ISO 8601, or epoch ms).
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
6886
7430
  */
6887
7431
  since?: string;
6888
7432
  /**
@@ -6892,7 +7436,7 @@ type ListPeopleData = {
6892
7436
  /**
6893
7437
  * People with an account on any of these platforms. Repeatable, or comma-separated.
6894
7438
  */
6895
- 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'>;
6896
7440
  /**
6897
7441
  * People carrying any of these tags. Repeatable, or comma-separated.
6898
7442
  */
@@ -6920,7 +7464,7 @@ type ListPeopleData = {
6920
7464
  /**
6921
7465
  * Nobody with an account on these platforms. Repeatable, or comma-separated.
6922
7466
  */
6923
- 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'>;
6924
7468
  /**
6925
7469
  * Nobody carrying any of these tags. Repeatable, or comma-separated.
6926
7470
  */
@@ -7000,7 +7544,7 @@ type ListPeopleResponses = {
7000
7544
  /**
7001
7545
  * Platform of the canonical account; `accounts` lists every account.
7002
7546
  */
7003
- 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';
7004
7548
  /**
7005
7549
  * Display name as of their newest post; null when the platform has none.
7006
7550
  */
@@ -7023,9 +7567,9 @@ type ListPeopleResponses = {
7023
7567
  */
7024
7568
  id: string;
7025
7569
  /**
7026
- * 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).
7027
7571
  */
7028
- 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';
7029
7573
  /**
7030
7574
  * Display name as the platform reports it.
7031
7575
  */
@@ -7185,7 +7729,7 @@ type UpdatePersonData = {
7185
7729
  tags?: Array<string>;
7186
7730
  notes?: string;
7187
7731
  /**
7188
- * true hides their posts from the feed, the alerts and the digests; false shows them again. Without groupId, for every keyword of the workspace; with groupId, for the mentions of that group's keywords only, leaving the workspace's mute as it is.
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.
7189
7733
  */
7190
7734
  muted?: boolean;
7191
7735
  /**
@@ -7400,6 +7944,12 @@ type LogPersonActivityData = {
7400
7944
  */
7401
7945
  memberId?: string;
7402
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
+ };
7403
7953
  path: {
7404
7954
  /**
7405
7955
  * Person id (aut_...).
@@ -7474,6 +8024,31 @@ type DeletePersonActivityResponses = {
7474
8024
  204: void;
7475
8025
  };
7476
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];
7477
8052
  type ListSegmentsData = {
7478
8053
  body?: never;
7479
8054
  path?: never;
@@ -7498,7 +8073,7 @@ type ListSegmentsErrors = {
7498
8073
  type ListSegmentsError = ListSegmentsErrors[keyof ListSegmentsErrors];
7499
8074
  type ListSegmentsResponses = {
7500
8075
  /**
7501
- * Every segment, with presets
8076
+ * Every segment
7502
8077
  */
7503
8078
  200: {
7504
8079
  data: Array<{
@@ -7512,7 +8087,7 @@ type ListSegmentsResponses = {
7512
8087
  /**
7513
8088
  * People with an account on any of these platforms.
7514
8089
  */
7515
- 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'>;
7516
8091
  /**
7517
8092
  * People carrying any of these tags.
7518
8093
  */
@@ -7548,7 +8123,7 @@ type ListSegmentsResponses = {
7548
8123
  /**
7549
8124
  * Nobody with an account on these platforms.
7550
8125
  */
7551
- 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'>;
7552
8127
  /**
7553
8128
  * Nobody carrying any of these tags.
7554
8129
  */
@@ -7600,87 +8175,11 @@ type ListSegmentsResponses = {
7600
8175
  updatedAt: string;
7601
8176
  }>;
7602
8177
  /**
7603
- * 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
7604
8181
  */
7605
- presets: Array<{
7606
- key: string;
7607
- name: string;
7608
- description: string;
7609
- filter: {
7610
- /**
7611
- * People with an account on any of these platforms.
7612
- */
7613
- platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
7614
- /**
7615
- * People carrying any of these tags.
7616
- */
7617
- tags?: Array<string>;
7618
- /**
7619
- * At least this many followers. Unknown reach never matches.
7620
- */
7621
- minFollowers?: number;
7622
- /**
7623
- * At most this many followers. Unknown reach never matches.
7624
- */
7625
- maxFollowers?: number;
7626
- /**
7627
- * At least this many matched mentions.
7628
- */
7629
- minMentions?: number;
7630
- /**
7631
- * At least this many negative mentions.
7632
- */
7633
- minNegative?: number;
7634
- /**
7635
- * At least one mention carrying any of these intents.
7636
- */
7637
- intents?: Array<string>;
7638
- /**
7639
- * Mentioned a keyword of any of these kinds.
7640
- */
7641
- keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
7642
- /**
7643
- * Never mentioned a keyword of these kinds.
7644
- */
7645
- neverKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
7646
- /**
7647
- * Nobody with an account on these platforms.
7648
- */
7649
- notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
7650
- /**
7651
- * Nobody carrying any of these tags.
7652
- */
7653
- notTags?: Array<string>;
7654
- /**
7655
- * Nobody whose mentions carry any of these intents.
7656
- */
7657
- notIntents?: Array<string>;
7658
- /**
7659
- * First seen within this many days.
7660
- */
7661
- newSinceDays?: number;
7662
- /**
7663
- * At least one mention linking to any of these hosts, the host itself or a subdomain of it.
7664
- */
7665
- linkHosts?: Array<string>;
7666
- /**
7667
- * true: only muted people; false: only unmuted.
7668
- */
7669
- muted?: boolean;
7670
- /**
7671
- * People at any of these outreach stages.
7672
- */
7673
- stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
7674
- /**
7675
- * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
7676
- */
7677
- automated?: boolean;
7678
- /**
7679
- * People owned by any of these members (user ids); "none" matches people nobody owns.
7680
- */
7681
- ownerIds?: Array<string>;
7682
- };
7683
- }>;
8182
+ presets: Array<SegmentPreset>;
7684
8183
  };
7685
8184
  };
7686
8185
  type ListSegmentsResponse = ListSegmentsResponses[keyof ListSegmentsResponses];
@@ -7692,7 +8191,7 @@ type CreateSegmentData = {
7692
8191
  /**
7693
8192
  * People with an account on any of these platforms.
7694
8193
  */
7695
- 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'>;
7696
8195
  /**
7697
8196
  * People carrying any of these tags.
7698
8197
  */
@@ -7728,7 +8227,7 @@ type CreateSegmentData = {
7728
8227
  /**
7729
8228
  * Nobody with an account on these platforms.
7730
8229
  */
7731
- 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'>;
7732
8231
  /**
7733
8232
  * Nobody carrying any of these tags.
7734
8233
  */
@@ -7763,6 +8262,12 @@ type CreateSegmentData = {
7763
8262
  ownerIds?: Array<string>;
7764
8263
  };
7765
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
+ };
7766
8271
  path?: never;
7767
8272
  query?: {
7768
8273
  /**
@@ -7880,7 +8385,7 @@ type UpdateSegmentData = {
7880
8385
  /**
7881
8386
  * People with an account on any of these platforms.
7882
8387
  */
7883
- 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'>;
7884
8389
  /**
7885
8390
  * People carrying any of these tags.
7886
8391
  */
@@ -7916,7 +8421,7 @@ type UpdateSegmentData = {
7916
8421
  /**
7917
8422
  * Nobody with an account on these platforms.
7918
8423
  */
7919
- 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'>;
7920
8425
  /**
7921
8426
  * Nobody carrying any of these tags.
7922
8427
  */
@@ -8043,11 +8548,11 @@ type ListViewsResponses = {
8043
8548
  /**
8044
8549
  * Only posts from any of these platforms.
8045
8550
  */
8046
- 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'>;
8047
8552
  /**
8048
8553
  * Never posts from these platforms.
8049
8554
  */
8050
- 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'>;
8051
8556
  /**
8052
8557
  * Only mentions in this status: open, ignored, done.
8053
8558
  */
@@ -8147,6 +8652,10 @@ type ListViewsResponses = {
8147
8652
  /**
8148
8653
  * Never these authors: display names, handles or profile URLs.
8149
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
+ */
8150
8659
  excludeAuthors?: Array<string>;
8151
8660
  /**
8152
8661
  * Only app store reviews with any of these star ratings; every other post fails it.
@@ -8181,7 +8690,7 @@ type ListViewsResponses = {
8181
8690
  */
8182
8691
  minBookmarks?: number;
8183
8692
  /**
8184
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
8185
8694
  */
8186
8695
  anyOf?: Array<FilterGroup>;
8187
8696
  };
@@ -8238,11 +8747,11 @@ type CreateViewData = {
8238
8747
  /**
8239
8748
  * Only posts from any of these platforms.
8240
8749
  */
8241
- 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'>;
8242
8751
  /**
8243
8752
  * Never posts from these platforms.
8244
8753
  */
8245
- 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'>;
8246
8755
  /**
8247
8756
  * Only mentions in this status: open, ignored, done.
8248
8757
  */
@@ -8342,6 +8851,10 @@ type CreateViewData = {
8342
8851
  /**
8343
8852
  * Never these authors: display names, handles or profile URLs.
8344
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
+ */
8345
8858
  excludeAuthors?: Array<string>;
8346
8859
  /**
8347
8860
  * Only app store reviews with any of these star ratings; every other post fails it.
@@ -8376,11 +8889,17 @@ type CreateViewData = {
8376
8889
  */
8377
8890
  minBookmarks?: number;
8378
8891
  /**
8379
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
8380
8893
  */
8381
8894
  anyOf?: Array<FilterGroup>;
8382
8895
  };
8383
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
+ };
8384
8903
  path?: never;
8385
8904
  query?: never;
8386
8905
  url: '/v1/views';
@@ -8500,11 +9019,11 @@ type UpdateViewData = {
8500
9019
  /**
8501
9020
  * Only posts from any of these platforms.
8502
9021
  */
8503
- 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'>;
8504
9023
  /**
8505
9024
  * Never posts from these platforms.
8506
9025
  */
8507
- 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'>;
8508
9027
  /**
8509
9028
  * Only mentions in this status: open, ignored, done.
8510
9029
  */
@@ -8604,6 +9123,10 @@ type UpdateViewData = {
8604
9123
  /**
8605
9124
  * Never these authors: display names, handles or profile URLs.
8606
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
+ */
8607
9130
  excludeAuthors?: Array<string>;
8608
9131
  /**
8609
9132
  * Only app store reviews with any of these star ratings; every other post fails it.
@@ -8638,7 +9161,7 @@ type UpdateViewData = {
8638
9161
  */
8639
9162
  minBookmarks?: number;
8640
9163
  /**
8641
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
8642
9165
  */
8643
9166
  anyOf?: Array<FilterGroup>;
8644
9167
  };
@@ -8817,10 +9340,16 @@ type CreateGroupData = {
8817
9340
  */
8818
9341
  externalId?: string | null;
8819
9342
  /**
8820
- * What the classifier reads as "the company" for this group's keywords, in place of the WHOLE workspace profile, its relevance guidelines and competitor list included (at most 4000 characters): who the business is, what it sells, for whom, what is not it, and any rule that should apply to this group ("ignore job posts"). For a group per customer, the customer's description. Null: the workspace profile, as for every keyword before groups.
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).
8821
9344
  */
8822
9345
  context?: string | null;
8823
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
+ };
8824
9353
  path?: never;
8825
9354
  query?: never;
8826
9355
  url: '/v1/groups';
@@ -8919,7 +9448,7 @@ type UpdateGroupData = {
8919
9448
  */
8920
9449
  externalId?: string | null;
8921
9450
  /**
8922
- * Replaces the group's company description; null clears it (the workspace profile applies again). New mentions are judged with it at once; old ones are not rescored. Not on the default group (400 default_group_context): that one is the workspace itself and reads the profile.
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).
8923
9452
  */
8924
9453
  context?: string | null;
8925
9454
  };
@@ -9099,6 +9628,12 @@ type CreateApiKeyData = {
9099
9628
  */
9100
9629
  expiresAt?: string;
9101
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
+ };
9102
9637
  path?: never;
9103
9638
  query?: never;
9104
9639
  url: '/v1/api-keys';
@@ -9255,6 +9790,12 @@ type CreateInvitationData = {
9255
9790
  */
9256
9791
  role?: 'admin' | 'member';
9257
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
+ };
9258
9799
  path?: never;
9259
9800
  query?: never;
9260
9801
  url: '/v1/members/invitations';
@@ -9410,7 +9951,7 @@ type GetUsageBreakdownData = {
9410
9951
  /**
9411
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.
9412
9953
  */
9413
- 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'>;
9414
9955
  /**
9415
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.
9416
9957
  */
@@ -9455,6 +9996,12 @@ type CreateTopUpData = {
9455
9996
  */
9456
9997
  successUrl?: string;
9457
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
+ };
9458
10005
  path?: never;
9459
10006
  query?: never;
9460
10007
  url: '/v1/billing/top-ups';
@@ -9523,7 +10070,7 @@ type ListLedgerData = {
9523
10070
  */
9524
10071
  cursor?: string;
9525
10072
  /**
9526
- * Page size, 1 to 100 (default 25).
10073
+ * Page size, 1 to 100 (default 50).
9527
10074
  */
9528
10075
  limit?: number;
9529
10076
  };
@@ -9686,9 +10233,9 @@ type UpdateAlertData = {
9686
10233
  /**
9687
10234
  * Only posts from these platforms.
9688
10235
  */
9689
- 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'>;
9690
10237
  /**
9691
- * The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
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.
9692
10239
  */
9693
10240
  minRelevance?: number;
9694
10241
  /**
@@ -9772,7 +10319,7 @@ type UpdateAlertData = {
9772
10319
  */
9773
10320
  minBookmarks?: number;
9774
10321
  /**
9775
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
9776
10323
  */
9777
10324
  anyOf?: Array<FilterGroup>;
9778
10325
  };
@@ -9852,7 +10399,12 @@ type ListAlertsResponses = {
9852
10399
  name: string;
9853
10400
  enabled: boolean;
9854
10401
  /**
9855
- * instant: each matching mention as it happens. hourly: one digest each UTC hour (five minutes past, so the last mentions of the hour are scored) covering the previous full hour, nothing when that hour has no mention at or over the rule's relevance floor; Slack, Telegram and webhook channels only. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
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.
9856
10408
  */
9857
10409
  mode: 'instant' | 'hourly' | 'daily' | 'weekly';
9858
10410
  filter: {
@@ -9867,9 +10419,9 @@ type ListAlertsResponses = {
9867
10419
  /**
9868
10420
  * Only posts from these platforms.
9869
10421
  */
9870
- 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'>;
9871
10423
  /**
9872
- * The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
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.
9873
10425
  */
9874
10426
  minRelevance?: number;
9875
10427
  /**
@@ -9953,7 +10505,7 @@ type ListAlertsResponses = {
9953
10505
  */
9954
10506
  minBookmarks?: number;
9955
10507
  /**
9956
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
9957
10509
  */
9958
10510
  anyOf?: Array<FilterGroup>;
9959
10511
  };
@@ -10024,9 +10576,9 @@ type CreateAlertData = {
10024
10576
  /**
10025
10577
  * Only posts from these platforms.
10026
10578
  */
10027
- 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'>;
10028
10580
  /**
10029
- * The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass.
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.
10030
10582
  */
10031
10583
  minRelevance?: number;
10032
10584
  /**
@@ -10110,7 +10662,7 @@ type CreateAlertData = {
10110
10662
  */
10111
10663
  minBookmarks?: number;
10112
10664
  /**
10113
- * OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
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).
10114
10666
  */
10115
10667
  anyOf?: Array<FilterGroup>;
10116
10668
  };
@@ -10136,13 +10688,19 @@ type CreateAlertData = {
10136
10688
  */
10137
10689
  channelIds?: Array<string>;
10138
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
+ };
10139
10697
  path?: never;
10140
10698
  query?: never;
10141
10699
  url: '/v1/alerts';
10142
10700
  };
10143
10701
  type CreateAlertErrors = {
10144
10702
  /**
10145
- * A daily or weekly rule without a schedule (or a weekly one without a weekday), an hourly one with a weekday or an email channel (hourly_email_unsupported), an unknown channel, or anyOf groups binding more values than one query can carry (filter_too_complex)
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)
10146
10704
  */
10147
10705
  400: ErrorResponse;
10148
10706
  /**
@@ -10225,7 +10783,7 @@ type RunAlertDigestResponses = {
10225
10783
  */
10226
10784
  200: {
10227
10785
  /**
10228
- * Why nothing was sent, if nothing was: the period already went out, the window had nothing to show, (hourly rules) the hour's retry window closed before it could send, or another run of the same period is sending it right now.
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.
10229
10787
  */
10230
10788
  skipped: 'already_sent' | 'empty' | 'expired' | 'in_flight';
10231
10789
  matched: number;
@@ -10339,7 +10897,7 @@ type GetAnalyticsSummaryData = {
10339
10897
  /**
10340
10898
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
10341
10899
  */
10342
- 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'>;
10343
10901
  /**
10344
10902
  * true adds the period of the same length right before the window as `previous`.
10345
10903
  */
@@ -10392,7 +10950,7 @@ type GetAnalyticsSeriesData = {
10392
10950
  /**
10393
10951
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
10394
10952
  */
10395
- 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'>;
10396
10954
  /**
10397
10955
  * true adds the period of the same length right before the window as `previous`.
10398
10956
  */
@@ -10453,7 +11011,7 @@ type GetAnalyticsBreakdownData = {
10453
11011
  /**
10454
11012
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
10455
11013
  */
10456
- 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'>;
10457
11015
  /**
10458
11016
  * true adds the period of the same length right before the window as `previous`.
10459
11017
  */
@@ -10463,7 +11021,17 @@ type GetAnalyticsBreakdownData = {
10463
11021
  */
10464
11022
  timezone?: string;
10465
11023
  /**
10466
- * The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one), country (where the author is, ISO 3166-1 alpha-2; "unknown" for posts without one), subreddit (Reddit posts only, most active first; `share` stays a percent of the whole window, every platform included).
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.
10467
11035
  */
10468
11036
  by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit';
10469
11037
  };
@@ -10510,7 +11078,7 @@ type GetShareOfVoiceData = {
10510
11078
  /**
10511
11079
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
10512
11080
  */
10513
- 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'>;
10514
11082
  /**
10515
11083
  * true adds the period of the same length right before the window as `previous`.
10516
11084
  */
@@ -10563,7 +11131,7 @@ type GetReviewsReportData = {
10563
11131
  /**
10564
11132
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
10565
11133
  */
10566
- 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'>;
10567
11135
  /**
10568
11136
  * true adds the period of the same length right before the window as `previous`.
10569
11137
  */
@@ -10672,7 +11240,7 @@ type UpdateChannelData = {
10672
11240
  [key: string]: string;
10673
11241
  };
10674
11242
  /**
10675
- * Replaces the whole set of account events the channel receives. A webhook takes any of them; a Slack, email or Telegram channel the attention events only (mention.spike, sentiment.negative_spike, keyword.noisy, channel.failing, feed.failing, feed.recovered). An empty list unsubscribes it from all of them.
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).
10676
11244
  */
10677
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'>;
10678
11246
  };
@@ -10780,6 +11348,13 @@ type ListChannelDeliveriesData = {
10780
11348
  id: string;
10781
11349
  };
10782
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
+ */
10783
11358
  limit?: number;
10784
11359
  };
10785
11360
  url: '/v1/channels/{id}/deliveries';
@@ -10842,6 +11417,10 @@ type ListChannelDeliveriesResponses = {
10842
11417
  text: string;
10843
11418
  } | null;
10844
11419
  }>;
11420
+ /**
11421
+ * Pass back as `cursor` for the next page; null on the last page.
11422
+ */
11423
+ nextCursor: string | null;
10845
11424
  };
10846
11425
  };
10847
11426
  type ListChannelDeliveriesResponse = ListChannelDeliveriesResponses[keyof ListChannelDeliveriesResponses];
@@ -10875,6 +11454,12 @@ type CreateChannelData = {
10875
11454
  } & CreateEmailChannel) | ({
10876
11455
  kind: 'webhook';
10877
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
+ };
10878
11463
  path?: never;
10879
11464
  query?: never;
10880
11465
  url: '/v1/channels';
@@ -10915,17 +11500,28 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
10915
11500
  */
10916
11501
  meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
10917
11502
  };
11503
+ /**
11504
+ * Check the API is up
11505
+ */
10918
11506
  declare const getHealth: <ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>) => RequestResult<GetHealthResponses, unknown, ThrowOnError>;
10919
11507
  /**
10920
11508
  * List keywords
10921
11509
  *
10922
- * The keywords of the workspace with their match stats and poll health. Without parameters: every keyword, newest first. `q` searches the term and the context; `kind`, `status` and `platform` narrow the list; `sort` orders it; `limit` and `offset` page it. `total` counts the keywords that matched before paging.
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.
10923
11513
  */
10924
11514
  declare const listKeywords: <ThrowOnError extends boolean = false>(options?: Options<ListKeywordsData, ThrowOnError>) => RequestResult<ListKeywordsResponses, ListKeywordsErrors, ThrowOnError>;
10925
11515
  /**
10926
11516
  * Track a keyword
10927
11517
  *
10928
- * Start tracking a word or phrase. Matching, classification and delivery begin on the next poll. A funded workspace tracks up to 500 keywords; each costs $5 per month, deducted daily from the balance. `matching` narrows what the term matches (required and excluded terms, excluded authors, case, subreddits, GitHub repository events) before a mention is stored, so a rejected post is never billed; `context` is a sentence the classifier reads for this keyword only. `cap` puts a monthly ceiling on its matched mentions: at the cap it stops matching until the first of the next month (UTC) or until the cap is raised, while its daily keyword charge continues.
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).
10929
11525
  */
10930
11526
  declare const createKeyword: <ThrowOnError extends boolean = false>(options: Options<CreateKeywordData, ThrowOnError>) => RequestResult<CreateKeywordResponses, CreateKeywordErrors, ThrowOnError>;
10931
11527
  /**
@@ -10941,37 +11537,57 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
10941
11537
  /**
10942
11538
  * Update a keyword
10943
11539
  *
10944
- * Rename it (`term`: the new term is tracked from now on, with no look-back; the mentions the old term found stay), mute or unmute it, reclassify it (`kind`), change the platforms it is tracked on, its classifier `context`, its `matching` rules (each rule field optional; an empty list clears one), or its monthly mention `cap` (null removes it; a cap above this month's count resumes a capped keyword at once). Rules apply to new mentions from the next poll; stored mentions are untouched.
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.
10945
11545
  */
10946
11546
  declare const updateKeyword: <ThrowOnError extends boolean = false>(options: Options<UpdateKeywordData, ThrowOnError>) => RequestResult<UpdateKeywordResponses, UpdateKeywordErrors, ThrowOnError>;
10947
11547
  /**
10948
11548
  * Get a keyword's health
10949
11549
  *
10950
- * Whether the keyword earns what it costs over a trailing window (`range`, default 30d): a status (healthy, noisy, quiet, capped, paused, new) with the reasons in plain words, its numbers by platform and week, what it cost, the words and authors its noise is made of, and suggestions. Each suggestion carries a `patch` to send to PATCH /v1/keywords/{id} as is, and the effect it would have had, measured by running the matcher's own rules over the window's posts. `ai=true` adds a context rewritten by a language model (cached a day, at most 20 model calls an hour per workspace). Read only and never billed; the report is cached for 5 minutes, and a change to the keyword starts a fresh one. At most 30 reads a minute per workspace.
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).
10951
11556
  */
10952
11557
  declare const getKeywordHealth: <ThrowOnError extends boolean = false>(options: Options<GetKeywordHealthData, ThrowOnError>) => RequestResult<GetKeywordHealthResponses, GetKeywordHealthErrors, ThrowOnError>;
10953
11558
  /**
10954
11559
  * Duplicate a keyword
10955
11560
  *
10956
- * A new keyword with this one's settings and a new `term` (or the same term in another group): its kind, platforms, context, every matching rule, its monthly mention cap and its comments setting. Review apps and feeds are copied only when listed in `include`. It is a new keyword: $5 per month, and the newest posts of the last 30 days come in at once, as with any new keyword.
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.
10957
11564
  */
10958
11565
  declare const duplicateKeyword: <ThrowOnError extends boolean = false>(options: Options<DuplicateKeywordData, ThrowOnError>) => RequestResult<DuplicateKeywordResponses, DuplicateKeywordErrors, ThrowOnError>;
10959
11566
  /**
10960
11567
  * List feeds
10961
11568
  *
10962
- * The RSS and Atom feeds the workspace reads (forums, communities, blogs), newest connection first, each with how its hourly poll goes. Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace.
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).
10963
11572
  */
10964
11573
  declare const listFeeds: <ThrowOnError extends boolean = false>(options?: Options<ListFeedsData, ThrowOnError>) => RequestResult<ListFeedsResponses, ListFeedsErrors, ThrowOnError>;
10965
11574
  /**
10966
11575
  * Connect a feed
10967
11576
  *
10968
- * Connect an RSS or Atom feed: a feed's address, or a page's (a forum, a community, a blog), in which case the feed the page advertises is used, else a usual address such as /feed or /rss. Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace. A new feed brings each reading keyword the newest 10 items of the last 30 days that hold its term, never as instant alerts. A feed the workspace reads already comes back with 200 (connecting is idempotent). A members-only forum answers `feed_login_required`: send it again with `auth` (a cookie or a header), stored encrypted and read for this workspace alone.
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).
10969
11583
  */
10970
11584
  declare const createFeed: <ThrowOnError extends boolean = false>(options: Options<CreateFeedData, ThrowOnError>) => RequestResult<CreateFeedResponses, CreateFeedErrors, ThrowOnError>;
10971
11585
  /**
10972
11586
  * Connect many feeds
10973
11587
  *
10974
- * Connect up to 100 feeds in one call, each { url } or { url, auth } for a members-only one, checked on its own and reported added, already or failed, in the order sent: one that fails never stops the others. A failure carries the error code POST /v1/feeds would answer for that address (feed_login_required: send it again with auth). Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace. The first 8 added bring each reading keyword the newest 10 matching items of the last 30 days; the rest start from now.
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).
10975
11591
  */
10976
11592
  declare const importFeeds: <ThrowOnError extends boolean = false>(options: Options<ImportFeedsData, ThrowOnError>) => RequestResult<ImportFeedsResponses, ImportFeedsErrors, ThrowOnError>;
10977
11593
  /**
@@ -10987,121 +11603,182 @@ declare const getFeed: <ThrowOnError extends boolean = false>(options: Options<G
10987
11603
  /**
10988
11604
  * Update a feed
10989
11605
  *
10990
- * Rename a feed (title, null clears it), or set its sign-in for a members-only forum (auth: a cookie copied from your browser, or one header such as Discourse's Api-Key). A sign-in is checked by reading the feed with it, stored encrypted, sent to the feed's own site alone and never shown again; the feed is then read for this workspace alone. auth: null removes it.
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.
10991
11609
  */
10992
11610
  declare const updateFeed: <ThrowOnError extends boolean = false>(options: Options<UpdateFeedData, ThrowOnError>) => RequestResult<UpdateFeedResponses, UpdateFeedErrors, ThrowOnError>;
10993
11611
  /**
10994
11612
  * Get the workspace filters
10995
11613
  *
10996
- * The noise rules applied to every keyword before a mention is stored: excluded terms and authors, excluded GitHub repositories, and the subreddits Reddit posts may (or may not) come from. A post they reject is never classified, delivered or billed. Keyword-level rules live on each keyword (`matching`); both apply.
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.
10997
11617
  */
10998
11618
  declare const getFilters: <ThrowOnError extends boolean = false>(options?: Options<GetFiltersData, ThrowOnError>) => RequestResult<GetFiltersResponses, GetFiltersErrors, ThrowOnError>;
10999
11619
  /**
11000
11620
  * Update the workspace filters
11001
11621
  *
11002
- * Replace any of the lists; an omitted list is untouched and an empty one clears it. Entries are stored in canonical form (terms lowercased, authors as profile links or bare names, repositories as owner/name, subreddits without r/). Takes effect on new mentions within a minute; stored mentions are untouched.
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.
11003
11625
  */
11004
11626
  declare const updateFilters: <ThrowOnError extends boolean = false>(options: Options<UpdateFiltersData, ThrowOnError>) => RequestResult<UpdateFiltersResponses, UpdateFiltersErrors, ThrowOnError>;
11005
11627
  /**
11006
11628
  * Get a mention
11007
11629
  *
11008
- * One mention by id, as it appears in the list: 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.
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.
11009
11633
  */
11010
11634
  declare const getMention: <ThrowOnError extends boolean = false>(options: Options<GetMentionData, ThrowOnError>) => RequestResult<GetMentionResponses, GetMentionErrors, ThrowOnError>;
11011
11635
  /**
11012
11636
  * Update a mention
11013
11637
  *
11014
- * The one write on a mention. Set status to ignored or done to handle it (open puts it back), assign it to a workspace member, snooze it out of the feed, leave an internal note, or correct the classifier: `relevant` true or false is your verdict (relevance becomes 100 or 0, and every list, filter, digest and report follows it), `sentiment` replaces the label; null withdraws a verdict and restores the classifier's value. Omitted fields are untouched. Delivery and billing never change.
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.
11015
11642
  */
11016
11643
  declare const updateMention: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionData, ThrowOnError>) => RequestResult<UpdateMentionResponses, UpdateMentionErrors, ThrowOnError>;
11017
11644
  /**
11018
11645
  * List mentions
11019
11646
  *
11020
- * Mentions matched to your keywords, filtered and paginated. Default order is newest match first; sort=priority ranks the last 30 days of matches by attention score. Page with nextCursor, passing the same filters and sort. A mention is one post matched to one keyword. alertId applies an alert rule's filter on top of the others: the same mentions that rule would send. anyOf adds OR: URL-encoded JSON groups of conditions, at least one of which must hold on top of every other filter.
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).
11021
11652
  */
11022
11653
  declare const searchMentions: <ThrowOnError extends boolean = false>(options?: Options<SearchMentionsData, ThrowOnError>) => RequestResult<SearchMentionsResponses, SearchMentionsErrors, ThrowOnError>;
11023
11654
  /**
11024
11655
  * Export mentions as CSV
11025
11656
  *
11026
- * The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them), duplicate_of (the mention a cross-post copies; the CSV keeps one row per mention, copies included, so it adds up to the bill), kind (post, comment or repository), parent_url (the post a comment answers), comments (comments of it delivered to you), subreddit and flair (Reddit only), country (where the author is, ISO 3166-1 alpha-2, empty when unknown) and organization (true when a company or organization posted). Capped at 10,000 rows; the X-Mentions-Truncated header says when the cap cut the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
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).
11027
11663
  */
11028
11664
  declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
11029
11665
  /**
11030
11666
  * List the comments of a mention
11031
11667
  *
11032
- * The comments under a mention's post, newest first: every comment in the thread, whether or not it names your keyword. Read once, about a day after the post, for mentions scored relevant whose keyword has comments enabled (keywords.comments), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit; empty before that and for other keywords. Each comment delivered costs $0.008 on the comments line of the bill, once per workspace. A comment that itself names one of your keywords is also a mention: `mentionId` links it. Two mentions of one post (two keywords) list the same thread.
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).
11033
11671
  */
11034
11672
  declare const listMentionComments: <ThrowOnError extends boolean = false>(options: Options<ListMentionCommentsData, ThrowOnError>) => RequestResult<ListMentionCommentsResponses, ListMentionCommentsErrors, ThrowOnError>;
11035
11673
  /**
11036
11674
  * Export mentions as JSON
11037
11675
  *
11038
- * The same mentions GET /v1/mentions would list for these filters, in one response, newest matched first (the order they entered your feed): every row is the full Mention object the list returns, text included. Capped at 10,000 mentions; `truncated` (and the X-Mentions-Truncated header) says when the cap cut the list. Shares the CSV export's limit: at most 6 exports per minute per workspace, either format; a 429 carries Retry-After.
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).
11039
11682
  */
11040
11683
  declare const exportMentionsJson: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsJsonData, ThrowOnError>) => RequestResult<ExportMentionsJsonResponses, ExportMentionsJsonErrors, ThrowOnError>;
11041
11684
  /**
11042
11685
  * Export people as CSV
11043
11686
  *
11044
- * The same list as GET /v1/people (segmentId included) as CSV, one row per person with their contact columns: handle, followers, email, website, company, location, tags, then outreach stage, owner and last contacted. Capped at 5,000 people. `groupId` scopes the export like the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
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).
11045
11690
  */
11046
11691
  declare const exportPeopleCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportPeopleCsvData, ThrowOnError>) => RequestResult<ExportPeopleCsvResponses, ExportPeopleCsvErrors, ThrowOnError>;
11047
11692
  /**
11048
11693
  * List people
11049
11694
  *
11050
- * The people behind your mentions: one row per person, with their accounts, reach, public profile, per-workspace stats, your annotations and where your outreach stands. Filter by platform, tag, follower range, mention counts, intents seen, keyword kinds mentioned or never mentioned, outreach stage, owner, automated (bot accounts, whose matched posts are mostly machine-made), or a saved segment. Offset-paginated with a total. With `groupId`, only the people who mentioned that keyword group's keywords, counted over those mentions, with that group's own annotations, merges, outreach and segments.
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).
11051
11698
  */
11052
11699
  declare const listPeople: <ThrowOnError extends boolean = false>(options?: Options<ListPeopleData, ThrowOnError>) => RequestResult<ListPeopleResponses, ListPeopleErrors, ThrowOnError>;
11053
11700
  /**
11054
11701
  * Get a person
11055
11702
  *
11056
- * One person as your workspace sees them. An account merged into someone resolves to that person. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
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).
11057
11706
  */
11058
11707
  declare const getPerson: <ThrowOnError extends boolean = false>(options: Options<GetPersonData, ThrowOnError>) => RequestResult<GetPersonResponses, GetPersonErrors, ThrowOnError>;
11059
11708
  /**
11060
11709
  * Update your annotations on a person
11061
11710
  *
11062
- * Tags, notes, mute, and the outreach owner (a workspace member; null clears) and stage, for your workspace only. Mute hides their posts from your feed and every channel; ingest and billing never change. With `groupId` the annotations are that keyword group's own: `muted` hides the person, and the accounts that group merged into them, from the mentions of that group's keywords only (feed, alerts and digests), and the group's tags show on those mentions next to the workspace's. A mute set without `groupId` hides them everywhere.
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).
11063
11714
  */
11064
11715
  declare const updatePerson: <ThrowOnError extends boolean = false>(options: Options<UpdatePersonData, ThrowOnError>) => RequestResult<UpdatePersonResponses, UpdatePersonErrors, ThrowOnError>;
11065
11716
  /**
11066
11717
  * Merge an account into a person
11067
11718
  *
11068
- * Declare that this account and another person are the same human, for your workspace only. Their mentions, tags, notes and outreach activities combine under the person named by `into`, which keeps its owner and stage unless it had none. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
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).
11069
11724
  */
11070
11725
  declare const mergePeople: <ThrowOnError extends boolean = false>(options: Options<MergePeopleData, ThrowOnError>) => RequestResult<MergePeopleResponses, MergePeopleErrors, ThrowOnError>;
11071
11726
  /**
11072
11727
  * Undo a merge
11073
11728
  *
11074
- * The account becomes its own person again. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
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).
11075
11732
  */
11076
11733
  declare const splitPerson: <ThrowOnError extends boolean = false>(options: Options<SplitPersonData, ThrowOnError>) => RequestResult<SplitPersonResponses, SplitPersonErrors, ThrowOnError>;
11077
11734
  /**
11078
11735
  * List outreach activities
11079
11736
  *
11080
- * Every logged contact with this person across all their accounts, newest first (at most 200): who reached out, the channel, when, and a short note. Read it before reaching out so two teammates never contact the same person without knowing. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
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).
11081
11742
  */
11082
11743
  declare const listPersonActivities: <ThrowOnError extends boolean = false>(options: Options<ListPersonActivitiesData, ThrowOnError>) => RequestResult<ListPersonActivitiesResponses, ListPersonActivitiesErrors, ThrowOnError>;
11083
11744
  /**
11084
11745
  * Log an outreach activity
11085
11746
  *
11086
- * Record that a teammate reached out to this person: an email, a DM, a call. The first activity claims an unowned person for whoever reached out and moves not_contacted to contacted; an existing owner and a later stage are kept. `memberId` defaults to the signed-in member; an API key that omits it logs an unattributed activity, which claims nobody. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
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).
11087
11752
  */
11088
11753
  declare const logPersonActivity: <ThrowOnError extends boolean = false>(options: Options<LogPersonActivityData, ThrowOnError>) => RequestResult<LogPersonActivityResponses, LogPersonActivityErrors, ThrowOnError>;
11089
11754
  /**
11090
11755
  * Delete an outreach activity
11091
11756
  *
11092
- * Remove a contact logged by mistake. The person's owner and stage stay as they are. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
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).
11093
11760
  */
11094
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>;
11095
11768
  /**
11096
11769
  * List segments
11097
11770
  *
11098
- * Your saved segments, each with the number of people in it right now (segments are evaluated on every read, never materialized), plus presets you can save as a starting point. Pass a segment id to GET /v1/people to list its members. With `groupId`, that keyword group's own segments, counted over its own people; without it, the workspace's. A segment belongs to one scope and is not visible from another.
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.
11099
11774
  */
11100
11775
  declare const listSegments: <ThrowOnError extends boolean = false>(options?: Options<ListSegmentsData, ThrowOnError>) => RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError>;
11101
11776
  /**
11102
11777
  * Create a segment
11103
11778
  *
11104
- * Save a named filter over your people. 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.
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.
11105
11782
  */
11106
11783
  declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError>;
11107
11784
  /**
@@ -11125,13 +11802,17 @@ declare const updateSegment: <ThrowOnError extends boolean = false>(options: Opt
11125
11802
  /**
11126
11803
  * List views
11127
11804
  *
11128
- * The saved views of the workspace, oldest first. 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.
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.
11129
11808
  */
11130
11809
  declare const listViews: <ThrowOnError extends boolean = false>(options?: Options<ListViewsData, ThrowOnError>) => RequestResult<ListViewsResponses, ListViewsErrors, ThrowOnError>;
11131
11810
  /**
11132
11811
  * Save a view
11133
11812
  *
11134
- * Save a named filter over mentions. The filter takes the same fields as GET /v1/mentions (lists are any-of, `not` lists none-of, every condition ANDed), plus `anyOf`, groups of those conditions of which at least one must hold; an empty filter is every mention. Nothing is materialized: the view selects whatever matches when it is read.
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).
11135
11816
  */
11136
11817
  declare const createView: <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => RequestResult<CreateViewResponses, CreateViewErrors, ThrowOnError>;
11137
11818
  /**
@@ -11153,31 +11834,41 @@ declare const updateView: <ThrowOnError extends boolean = false>(options: Option
11153
11834
  /**
11154
11835
  * List attention items
11155
11836
  *
11156
- * What needs a person, newest first: a keyword whose mentions spiked in the last hour (mention.spike), whose negative share of the last 24 hours jumped (sentiment.negative_spike), that turned noisy (keyword.noisy), or a channel whose last sends all failed (channel.failing). Detected once an hour; an item opens when its condition starts and resolves on its own when the condition is gone. Open items by default; `status=all` reads the history. Each opening is also an account event of the same name, which webhook, Slack, email and Telegram channels can subscribe to.
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).
11157
11840
  */
11158
11841
  declare const listAttention: <ThrowOnError extends boolean = false>(options?: Options<ListAttentionData, ThrowOnError>) => RequestResult<ListAttentionResponses, ListAttentionErrors, ThrowOnError>;
11159
11842
  /**
11160
11843
  * Dismiss an attention item
11161
11844
  *
11162
- * Put an item away. 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. Idempotent.
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.
11163
11848
  */
11164
11849
  declare const dismissAttention: <ThrowOnError extends boolean = false>(options: Options<DismissAttentionData, ThrowOnError>) => RequestResult<DismissAttentionResponses, DismissAttentionErrors, ThrowOnError>;
11165
11850
  /**
11166
11851
  * List groups
11167
11852
  *
11168
- * The keyword groups of the workspace, the default group first, then oldest first. A group is how keywords are grouped (a customer, a campaign, a product): a term may be tracked once per group, every keyword belongs to one, and GET /v1/usage/breakdown?by=group says what each group cost. Pass `externalId` to find the group carrying your own id.
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).
11169
11856
  */
11170
11857
  declare const listGroups: <ThrowOnError extends boolean = false>(options?: Options<ListGroupsData, ThrowOnError>) => RequestResult<ListGroupsResponses, ListGroupsErrors, ThrowOnError>;
11171
11858
  /**
11172
11859
  * Create a group
11173
11860
  *
11174
- * Create a keyword group. `name` is unique per workspace; `externalId` (optional, unique too) is your own id for it, a customer id say, so you can find it again without storing ours; `context` (optional) is the group's own company description, which the classifier reads in place of the whole workspace profile for the group's keywords. Then pass the group id as `groupId` when creating a keyword.
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).
11175
11864
  */
11176
11865
  declare const createGroup: <ThrowOnError extends boolean = false>(options: Options<CreateGroupData, ThrowOnError>) => RequestResult<CreateGroupResponses, CreateGroupErrors, ThrowOnError>;
11177
11866
  /**
11178
11867
  * Delete a group and its keywords
11179
11868
  *
11180
- * Deletes the group and EVERY keyword in it, each the way DELETE /v1/keywords/{id} does (its mentions go with it, alert rules that named it are adjusted; charges already made stay on the usage record). Read the group first: `stats.keywords` says how many go. The default group cannot be deleted: move or delete its keywords instead.
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.
11181
11872
  */
11182
11873
  declare const deleteGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteGroupData, ThrowOnError>) => RequestResult<DeleteGroupResponses, DeleteGroupErrors, ThrowOnError>;
11183
11874
  /**
@@ -11187,7 +11878,9 @@ declare const getGroup: <ThrowOnError extends boolean = false>(options: Options<
11187
11878
  /**
11188
11879
  * Update a group
11189
11880
  *
11190
- * Rename a group, change your id for it (`externalId`, null clears) or its company description (`context`, null clears: the workspace profile applies again; new mentions are judged with it at once, old ones are not rescored). The default group can be renamed like any other but takes no description: it is the workspace itself and reads the company profile.
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.
11191
11884
  */
11192
11885
  declare const updateGroup: <ThrowOnError extends boolean = false>(options: Options<UpdateGroupData, ThrowOnError>) => RequestResult<UpdateGroupResponses, UpdateGroupErrors, ThrowOnError>;
11193
11886
  /**
@@ -11209,7 +11902,9 @@ declare const listApiKeys: <ThrowOnError extends boolean = false>(options?: Opti
11209
11902
  /**
11210
11903
  * Create an API key
11211
11904
  *
11212
- * Mint a key for this workspace. The key itself is returned once; only its hash is stored. `expiresAt` makes it stop working at an instant (a key for a contractor or a one-off script); it stays listed until revoked.
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.
11213
11908
  */
11214
11909
  declare const createApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>) => RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
11215
11910
  /**
@@ -11221,7 +11916,9 @@ declare const revokeApiKey: <ThrowOnError extends boolean = false>(options: Opti
11221
11916
  /**
11222
11917
  * Introspect the credential
11223
11918
  *
11224
- * The workspace this credential acts on, how the request authenticated (an API key, an OAuth access token from an MCP sign-in, or the dashboard session), whether it may write, and for a key its id and expiry. Run it first: a read key answers 403 read_only_key on every write, and a wrong workspace is the classic scripting mistake.
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.
11225
11922
  */
11226
11923
  declare const whoami: <ThrowOnError extends boolean = false>(options?: Options<WhoamiData, ThrowOnError>) => RequestResult<WhoamiResponses, WhoamiErrors, ThrowOnError>;
11227
11924
  /**
@@ -11239,7 +11936,9 @@ declare const listInvitations: <ThrowOnError extends boolean = false>(options?:
11239
11936
  /**
11240
11937
  * Invite a member
11241
11938
  *
11242
- * Send an email invitation to join the workspace as admin or member; it expires after 48 hours. Idempotent: an address that already holds an open invitation gets it back with 200 and no second email. An address that is already a member is a 409 already_member. Team changes need a signed-in owner or admin (an OAuth token from an MCP sign-in, or the dashboard session): an API key answers 403.
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.
11243
11942
  */
11244
11943
  declare const createInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateInvitationData, ThrowOnError>) => RequestResult<CreateInvitationResponses, CreateInvitationErrors, ThrowOnError>;
11245
11944
  /**
@@ -11251,43 +11950,60 @@ declare const revokeInvitation: <ThrowOnError extends boolean = false>(options:
11251
11950
  /**
11252
11951
  * Remove a member
11253
11952
  *
11254
- * The person loses the workspace within a minute (their dashboard session on the next request, an OAuth token when its short cache lapses). Their mentions, notes and outreach stay. Needs a signed-in owner or admin; only an owner removes another owner, and the last owner cannot be removed (409 last_owner).
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).
11255
11956
  */
11256
11957
  declare const removeMember: <ThrowOnError extends boolean = false>(options: Options<RemoveMemberData, ThrowOnError>) => RequestResult<RemoveMemberResponses, RemoveMemberErrors, ThrowOnError>;
11257
11958
  /**
11258
11959
  * Get usage and balance
11259
11960
  *
11260
- * The prepaid balance (ledger, pending mention charges, and the effective balance the stop rule reads), the daily burn and the days it buys, the keywords the wallet runs and pauses, the matches recorded today and over 30 days, and whether tracking is stopped or the balance is low. Every matched mention bills ($0.008), relevant or not; every active keyword bills $5 a month, charged daily.
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).
11261
11964
  */
11262
11965
  declare const getUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) => RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError>;
11263
11966
  /**
11264
11967
  * Get the usage breakdown
11265
11968
  *
11266
- * What the workspace consumed and was charged over a window, grouped by one dimension per call (`by`: day, platform or keyword), in USD cents at list price, with the window's totals on every call. `range` reads a trailing window of UTC days ending today (default 30d); `month` reads one calendar month (YYYY-MM), the shape a bill or a per-customer margin is reconciled against. Keyword-days come from the daily tick and mention charges from the matches that billed, so a deleted keyword keeps its charges in the keyword rows (`keyword.removed`) while its mention counts read 0; the same numbers ride on each keyword as `stats.cost` for the running month. `totals.ledgerDebitCents` is what the wallet has debited so far for the window's days: mentions settle the morning after their day, so a window ending today lags `totals.totalCents` by the unsettled ones, and a closed month differs from it only by cumulative rounding. Rows are paged (`limit`, `offset`, `total`); a workspace may read this at most 30 times a minute through its keys and tokens together.
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).
11267
11975
  */
11268
11976
  declare const getUsageBreakdown: <ThrowOnError extends boolean = false>(options?: Options<GetUsageBreakdownData, ThrowOnError>) => RequestResult<GetUsageBreakdownResponses, GetUsageBreakdownErrors, ThrowOnError>;
11269
11977
  /**
11270
11978
  * Create a top-up checkout
11271
11979
  *
11272
- * Returns a hosted checkout URL with `amountCents` prefilled (editable there, $20 to $5,000). The balance is credited when the payment lands, within a minute, and tracking the wallet had paused resumes at once. Nothing is charged by this call itself. `successUrl` must be on an origin this deployment trusts; omit it for the dashboard's billing page.
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.
11273
11983
  */
11274
11984
  declare const createTopUp: <ThrowOnError extends boolean = false>(options: Options<CreateTopUpData, ThrowOnError>) => RequestResult<CreateTopUpResponses, CreateTopUpErrors, ThrowOnError>;
11275
11985
  /**
11276
11986
  * Get the wallet
11277
11987
  *
11278
- * The prepaid balance in full: ledger, pending mention charges and the effective balance the stop rule reads, the daily burn and the days it buys, how many keywords run and how many the wallet paused, what a day costs and what a resume needs, the welcome credit, the newest top-up, the top-up bounds and the auto-recharge settings. `GET /v1/usage` is the short form.
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.
11279
11991
  */
11280
11992
  declare const getWallet: <ThrowOnError extends boolean = false>(options?: Options<GetWalletData, ThrowOnError>) => RequestResult<GetWalletResponses, GetWalletErrors, ThrowOnError>;
11281
11993
  /**
11282
11994
  * List ledger entries
11283
11995
  *
11284
- * Every movement of the balance, newest first: the welcome credit, top-ups, refunds, the daily keyword-day and mention debits, adjustments. A debit row carries the UTC day it settled and the cumulative units behind it. Cursor paged.
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.
11285
11999
  */
11286
12000
  declare const listLedger: <ThrowOnError extends boolean = false>(options?: Options<ListLedgerData, ThrowOnError>) => RequestResult<ListLedgerResponses, ListLedgerErrors, ThrowOnError>;
11287
12001
  /**
11288
12002
  * List receipts
11289
12003
  *
11290
- * The orders behind the top-ups, newest first, as the merchant of record (Polar) holds them: this workspace's share of the billing customer's newest 100 orders. Empty before the first top-up.
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.
11291
12007
  */
11292
12008
  declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError>;
11293
12009
  /**
@@ -11315,7 +12031,12 @@ declare const listAlerts: <ThrowOnError extends boolean = false>(options?: Optio
11315
12031
  /**
11316
12032
  * Create an alert
11317
12033
  *
11318
- * A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; hourly sends one digest every UTC hour (five minutes past) for the previous full hour, nothing when it had no mention over the rule's floor, to Slack, Telegram and webhook channels only (no schedule); daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday). filter.anyOf adds OR: groups of conditions in the vocabulary of the mentions list, at least one of which must hold on top of the rest of the filter.
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).
11319
12040
  */
11320
12041
  declare const createAlert: <ThrowOnError extends boolean = false>(options: Options<CreateAlertData, ThrowOnError>) => RequestResult<CreateAlertResponses, CreateAlertErrors, ThrowOnError>;
11321
12042
  /**
@@ -11329,43 +12050,61 @@ declare const runAlertDigest: <ThrowOnError extends boolean = false>(options: Op
11329
12050
  /**
11330
12051
  * Mute authors on an alert
11331
12052
  *
11332
- * Add authors to the alert's muted list without touching the rest of its filter. Links are read the way the dashboard reads them: a post link mutes its author, twitter.com becomes x.com, a Hacker News profile keeps its id. Authors already muted are skipped, so a retry is safe. An entry that names no person (a subreddit, a story) rejects the request with that entry named.
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).
11333
12056
  */
11334
12057
  declare const muteAlertAuthors: <ThrowOnError extends boolean = false>(options: Options<MuteAlertAuthorsData, ThrowOnError>) => RequestResult<MuteAlertAuthorsResponses, MuteAlertAuthorsErrors, ThrowOnError>;
11335
12058
  /**
11336
12059
  * Unmute authors on an alert
11337
12060
  *
11338
- * Remove authors from the alert's muted list without touching the rest of its filter. 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.
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.
11339
12064
  */
11340
12065
  declare const unmuteAlertAuthors: <ThrowOnError extends boolean = false>(options: Options<UnmuteAlertAuthorsData, ThrowOnError>) => RequestResult<UnmuteAlertAuthorsResponses, UnmuteAlertAuthorsErrors, ThrowOnError>;
11341
12066
  /**
11342
12067
  * Headline counts for a window
11343
12068
  *
11344
- * Matched and relevant mentions, distinct posts and people, sentiment, buying intent and questions, estimated reach, and where the matches stand in triage. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date.
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.
11345
12072
  */
11346
12073
  declare const getAnalyticsSummary: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSummaryData, ThrowOnError>) => RequestResult<GetAnalyticsSummaryResponses, GetAnalyticsSummaryErrors, ThrowOnError>;
11347
12074
  /**
11348
12075
  * Mentions over time
11349
12076
  *
11350
- * Matched, relevant and sentiment counts per day or week across the window, as one total series or split per platform or per keyword with `by`. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date.
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.
11351
12080
  */
11352
12081
  declare const getAnalyticsSeries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSeriesData, ThrowOnError>) => RequestResult<GetAnalyticsSeriesResponses, GetAnalyticsSeriesErrors, ThrowOnError>;
11353
12082
  /**
11354
12083
  * Mentions grouped by one dimension
11355
12084
  *
11356
- * One table of matched, relevant and sentiment counts grouped by `by`: platform, keyword, sentiment, intent, status, hour (weekday and hour of day) or person. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date.
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.
11357
12088
  */
11358
12089
  declare const getAnalyticsBreakdown: <ThrowOnError extends boolean = false>(options: Options<GetAnalyticsBreakdownData, ThrowOnError>) => RequestResult<GetAnalyticsBreakdownResponses, GetAnalyticsBreakdownErrors, ThrowOnError>;
11359
12090
  /**
11360
12091
  * Brand against competitors
11361
12092
  *
11362
- * Every keyword matched in the window with its counts and its share of brand plus competitor matches; topic keywords are counted but stay out of the split. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date.
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.
11363
12098
  */
11364
12099
  declare const getShareOfVoice: <ThrowOnError extends boolean = false>(options?: Options<GetShareOfVoiceData, ThrowOnError>) => RequestResult<GetShareOfVoiceResponses, GetShareOfVoiceErrors, ThrowOnError>;
11365
12100
  /**
11366
12101
  * Reviews: stars over a window, per review page
11367
12102
  *
11368
- * The reviews a keyword collects (App Store, Google Play, Trustpilot, Google Maps): count, average stars, distribution, replies and open 1-2 star reviews, for the workspace and per review page with a series of average stars per `bucket`, plus the tags the unhappy reviews carry. A review matched by two keywords counts once. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date.
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.
11369
12108
  */
11370
12109
  declare const getReviewsReport: <ThrowOnError extends boolean = false>(options?: Options<GetReviewsReportData, ThrowOnError>) => RequestResult<GetReviewsReportResponses, GetReviewsReportErrors, ThrowOnError>;
11371
12110
  /**
@@ -11463,6 +12202,7 @@ declare const sdk_listMembers: typeof listMembers;
11463
12202
  declare const sdk_listMentionComments: typeof listMentionComments;
11464
12203
  declare const sdk_listPeople: typeof listPeople;
11465
12204
  declare const sdk_listPersonActivities: typeof listPersonActivities;
12205
+ declare const sdk_listSegmentPresets: typeof listSegmentPresets;
11466
12206
  declare const sdk_listSegments: typeof listSegments;
11467
12207
  declare const sdk_listViews: typeof listViews;
11468
12208
  declare const sdk_logPersonActivity: typeof logPersonActivity;
@@ -11491,7 +12231,7 @@ declare const sdk_updateSegment: typeof updateSegment;
11491
12231
  declare const sdk_updateView: typeof updateView;
11492
12232
  declare const sdk_whoami: typeof whoami;
11493
12233
  declare namespace sdk {
11494
- 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 };
11495
12235
  }
11496
12236
 
11497
12237
  /**
@@ -11519,4 +12259,4 @@ type Mentio = typeof sdk & {
11519
12259
  };
11520
12260
  declare function createMentio(options: MentioOptions): Mentio;
11521
12261
 
11522
- 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 };