@mentio-dev/sdk 0.10.0 → 0.11.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
@@ -385,13 +385,17 @@ type Keyword = {
385
385
  term: string;
386
386
  kind: 'brand' | 'competitor' | 'topic';
387
387
  /**
388
- * Not polled or matched. Either paused by you or by the wallet (see pausedForBalance). A keyword at its mention cap is not muted (see pausedForCap).
388
+ * Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
389
389
  */
390
390
  muted: boolean;
391
391
  /**
392
392
  * Muted by the wallet for lack of balance; a top-up resumes it, unmuting by hand needs balance too.
393
393
  */
394
394
  pausedForBalance: boolean;
395
+ /**
396
+ * 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.
397
+ */
398
+ pausedForNoise: boolean;
395
399
  /**
396
400
  * At its monthly mention cap: not matched until the first of next month (UTC) or until the cap is raised. Not muted: it keeps its place and its daily keyword charge.
397
401
  */
@@ -404,6 +408,14 @@ type Keyword = {
404
408
  * Matched mentions allowed per calendar month (UTC). Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
405
409
  */
406
410
  mentions: number;
411
+ /**
412
+ * Set by Mentio, not you: a workspace on its welcome credit collects at most 200 mentions a keyword a month. The first top-up removes it.
413
+ */
414
+ welcome: boolean;
415
+ /**
416
+ * Your own cap. With welcome true, the cap the keyword gets back at the first top-up (null for none); otherwise the same as mentions. Sending mentions: 200 back while welcome is true changes nothing.
417
+ */
418
+ own: number | null;
407
419
  } | null;
408
420
  group: GroupRef;
409
421
  /**
@@ -497,6 +509,10 @@ type Keyword = {
497
509
  */
498
510
  noisy: boolean;
499
511
  };
512
+ /**
513
+ * 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.
514
+ */
515
+ health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
500
516
  /**
501
517
  * 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.
502
518
  */
@@ -553,7 +569,7 @@ type ErrorResponse = {
553
569
  /**
554
570
  * 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.
555
571
  */
556
- code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'duplicate_view' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
572
+ code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | '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';
557
573
  /**
558
574
  * Human-readable detail; may change between releases.
559
575
  */
@@ -568,226 +584,591 @@ type ErrorResponse = {
568
584
  retryAfterSeconds?: number;
569
585
  };
570
586
  };
571
- /**
572
- * Workspace-wide matching rules; a rejected post is never billed.
573
- */
574
- type WorkspaceFilters = {
575
- /**
576
- * A post containing any of these is dropped, whatever keyword matched it. Same phrase rule as a keyword; a `*` at an end is a wildcard. "hiring, job, careers" is the classic list.
577
- */
578
- excludedTerms: Array<string>;
579
- /**
580
- * Posts by these authors are dropped everywhere: your own accounts, employees, known spammers. Profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form.
581
- */
582
- excludedAuthors: Array<string>;
583
- /**
584
- * GitHub repositories whose issues, pull requests and comments are dropped, as owner/name or a github.com link (facebook/react, https://github.com/facebook/react).
585
- */
586
- excludedRepos: Array<string>;
587
- /**
588
- * Reddit only.
589
- */
590
- subreddits: {
591
- /**
592
- * When non-empty, ONLY Reddit posts from these subreddits pass and `excluded` is ignored. r/name or name.
593
- */
594
- only: Array<string>;
595
- /**
596
- * Reddit posts from these subreddits are dropped. r/name or name.
597
- */
598
- excluded: Array<string>;
599
- };
600
- /**
601
- * Last edit; null until the first.
602
- */
603
- updatedAt: string | null;
604
- };
605
- type Mention = {
606
- /**
607
- * Mention id (mm_...): one post matched to one of your keywords. A post matching two keywords has two ids.
608
- */
609
- id: string;
610
- /**
611
- * open: nobody handled it yet. ignored: hidden from the feed and channels by you. done: handled.
612
- */
613
- status: 'open' | 'ignored' | 'done';
587
+ type KeywordSuggestion = {
614
588
  /**
615
- * The classifier scored it at or above the delivery threshold (40).
589
+ * excluded_terms and excluded_authors add to the matching rules; required_terms sets them; platforms drops the platforms that are almost all noise; context rewrites the sentence the classifier reads.
616
590
  */
617
- relevant: boolean;
591
+ type: 'excluded_terms' | 'excluded_authors' | 'required_terms' | 'platforms' | 'context';
618
592
  /**
619
- * Reached at least one of your channels.
593
+ * What it adds (terms, authors), drops (platforms) or writes (the context).
620
594
  */
621
- delivered: boolean;
595
+ values: Array<string>;
622
596
  /**
623
- * Attention score, one decimal, computed at read time: relevance halved, author reach on a follower ladder (unknown reach counts 8), the strongest intent (buy intent 20 down to praise 5), minus 2 per day of age floored at 20.
597
+ * The reason and the measured effect, in plain words.
624
598
  */
625
- priority: number;
599
+ why: string;
626
600
  /**
627
- * The keyword this post matched, and the group it is in.
601
+ * The body to send to PATCH /v1/keywords/{id} as is to apply it. A list holds the whole new list, current entries kept.
628
602
  */
629
- keyword: {
630
- /**
631
- * Keyword id (kw_...).
632
- */
633
- id: string;
603
+ patch: {
634
604
  /**
635
- * The tracked term.
605
+ * Reclassify it as brand, competitor or topic.
636
606
  */
637
- term: string;
638
- group: GroupRef;
639
- };
640
- post: {
607
+ kind?: 'brand' | 'competitor' | 'topic';
641
608
  /**
642
- * 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).
609
+ * A muted keyword stops polling and matching; its mentions stay.
643
610
  */
644
- platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
611
+ muted?: boolean;
645
612
  /**
646
- * Permalink of the post.
613
+ * Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).
647
614
  */
648
- url: string;
615
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
649
616
  /**
650
- * Title and body, truncated to 8 KB at ingest.
617
+ * 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.
651
618
  */
652
- text: string;
619
+ context?: string | null;
653
620
  /**
654
- * Links the post carries, in the order written, at most 20. Empty for a post with none, and for posts ingested before September 2026.
621
+ * Omitted fields are untouched; an empty list clears one.
655
622
  */
656
- links: Array<string>;
623
+ matching?: {
624
+ /**
625
+ * The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
626
+ */
627
+ requiredTerms?: Array<string>;
628
+ /**
629
+ * any: at least one required term must appear. all: every one must.
630
+ */
631
+ requiredMode?: 'any' | 'all';
632
+ /**
633
+ * A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
634
+ */
635
+ excludedTerms?: Array<string>;
636
+ /**
637
+ * Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
638
+ */
639
+ excludedAuthors?: Array<string>;
640
+ /**
641
+ * true: the term must appear in the case it was typed (RAG, never rag). Default false.
642
+ */
643
+ caseSensitive?: boolean;
644
+ };
657
645
  /**
658
- * When the post was published.
646
+ * Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it.
659
647
  */
660
- publishedAt: string;
648
+ cap?: {
649
+ /**
650
+ * Matched mentions allowed per calendar month (UTC). Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
651
+ */
652
+ mentions: number;
653
+ } | null;
661
654
  /**
662
- * 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.
655
+ * Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
663
656
  */
664
- engagement: {
665
- likes: number | null;
666
- reposts: number | null;
667
- replies: number | null;
668
- quotes: number | null;
669
- views: number | null;
670
- bookmarks: number | null;
671
- } | null;
657
+ groupId?: string;
672
658
  /**
673
- * The post this one replies to (X, Bluesky); null for top-level posts.
659
+ * Replaces the list of apps whose reviews this keyword collects; [] disconnects them all (their reviews stay). An app or country added here gets the free 30-day look-back; one already listed keeps its place.
674
660
  */
675
- replyTo: {
661
+ reviewSources?: Array<{
676
662
  /**
677
- * Parent post author as the platform names them.
663
+ * The review page's link: an App Store or Google Play app (https://apps.apple.com/us/app/notion/id1232780281, https://play.google.com/store/apps/details?id=notion.id), a Trustpilot page (https://www.trustpilot.com/review/notion.so) or a Google Maps place (its full link, or a maps.app.goo.gl share link). Or give platform and id.
678
664
  */
679
- author: string | null;
665
+ url?: string;
680
666
  /**
681
- * Parent post URL.
667
+ * appstore (Apple App Store), googleplay (Google Play), trustpilot (a company's Trustpilot page) or googlemaps (a place's Google reviews).
682
668
  */
683
- url: string | null;
669
+ platform?: 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
684
670
  /**
685
- * Parent post text, when the platform gave it.
671
+ * The id on the platform: the digits after "id" on the App Store, the package name on Google Play, the company's domain on Trustpilot (notion.so), a Place ID (ChIJ...) on Google Maps.
686
672
  */
687
- text: string | null;
688
- } | null;
673
+ id?: string;
674
+ /**
675
+ * 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.
676
+ */
677
+ countries?: Array<string>;
678
+ /**
679
+ * Google Play only: the language of the reviews to read (en, es, de, pt-BR); Google Play answers one language at a time. Default: the link's hl, else en.
680
+ */
681
+ language?: string;
682
+ }>;
689
683
  };
690
684
  /**
691
- * Who posted it; null when the platform gave no author at all.
685
+ * What the change would have done over the window, measured with the matcher's own rules. Null for a context, which changes scores, not matches.
692
686
  */
693
- author: {
687
+ effect: {
694
688
  /**
695
- * Person id (aut_...) for GET /v1/people/{id}; null when the account is not in the audience yet.
689
+ * Noise matches of the window (since stats.judgedSince when set) the change would have removed (estimated from the sample unless exact).
696
690
  */
697
- id: string | null;
691
+ noiseRemoved: number;
698
692
  /**
699
- * Display name as the platform reports it.
693
+ * Relevant matches of the window it would have removed.
700
694
  */
701
- name: string | null;
695
+ relevantRemoved: number;
702
696
  /**
703
- * Platform handle derived from the profile URL, formatted as the platform shows it (@name, u/name); null where the platform has none.
697
+ * What the removed matches cost at the mention rate: what the change would have saved over the window.
704
698
  */
705
- handle: string | null;
699
+ centsSaved: number;
706
700
  /**
707
- * Profile URL.
701
+ * The measurement behind the estimate: the matcher's own rules run over the sampled posts.
708
702
  */
709
- url: string | null;
703
+ sample: {
704
+ /**
705
+ * Sampled noise posts the change rejects.
706
+ */
707
+ noiseRemoved: number;
708
+ /**
709
+ * Noise posts sampled.
710
+ */
711
+ noise: number;
712
+ /**
713
+ * Sampled relevant posts the change rejects.
714
+ */
715
+ relevantRemoved: number;
716
+ /**
717
+ * Relevant posts sampled.
718
+ */
719
+ relevant: number;
720
+ };
710
721
  /**
711
- * Profile picture; null where the platform has none.
722
+ * The sample was the whole window, so the counts are measured, not estimated.
712
723
  */
713
- avatarUrl: string | null;
724
+ exact: boolean;
725
+ } | null;
726
+ /**
727
+ * rules: computed from the window's posts. ai: written by a language model (ai=true).
728
+ */
729
+ source: 'rules' | 'ai';
730
+ };
731
+ type KeywordHealth = {
732
+ /**
733
+ * The keyword the report is about.
734
+ */
735
+ keyword: {
714
736
  /**
715
- * Follower count as of their newest post; null where the platform has none.
737
+ * Keyword id (kw_...).
716
738
  */
717
- followers: number | null;
739
+ id: string;
718
740
  /**
719
- * Your workspace tags on this person.
741
+ * The term as typed.
720
742
  */
721
- tags: Array<string>;
722
- } | null;
743
+ term: string;
744
+ group: GroupRef;
745
+ };
723
746
  /**
724
- * An app store review's facts; null for every other post. Its sentiment comes from the stars (4 and 5 positive, 3 neutral, 1 and 2 negative) and it always counts as relevant, since you chose the app.
747
+ * The window the report reads, by match time, in UTC days.
725
748
  */
726
- review: {
749
+ window: {
727
750
  /**
728
- * Stars the reviewer gave.
751
+ * First day, YYYY-MM-DD, inclusive, UTC.
729
752
  */
730
- rating: number;
753
+ from: string;
731
754
  /**
732
- * The top of the scale: 5 on both stores.
755
+ * Last day, inclusive: today.
733
756
  */
734
- ratingMax: number;
757
+ to: string;
735
758
  /**
736
- * The review's headline; null where the store has none (Google Play).
759
+ * Length of the window in days.
737
760
  */
738
- title: string | null;
761
+ days: number;
762
+ };
763
+ /**
764
+ * 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).
765
+ */
766
+ status: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
767
+ /**
768
+ * Why, in plain words; the first line explains the status.
769
+ */
770
+ reasons: Array<string>;
771
+ /**
772
+ * Computed over the keyword's matches in the window.
773
+ */
774
+ stats: {
739
775
  /**
740
- * The app version the reviewer ran, when the store says.
776
+ * Matches recorded in the window, relevant or not.
741
777
  */
742
- version: string | null;
778
+ matches: number;
743
779
  /**
744
- * The storefront it was read in (App Store, Google Play) or the reviewer's country (Trustpilot), a lowercase two-letter code; null where the platform gives none.
780
+ * Scored at or above the relevance line (40).
745
781
  */
746
- country: string | null;
782
+ relevant: number;
747
783
  /**
748
- * The platform marks the review as verified (Trustpilot); null where the platform has no such mark.
784
+ * Scored under the line: the noise. Billed like any match.
749
785
  */
750
- verified: boolean | null;
786
+ filtered: number;
751
787
  /**
752
- * The developer's reply as it stood when the review was collected; null for none.
788
+ * Not scored yet, or failed to score (never billed).
753
789
  */
754
- response: string | null;
790
+ unscored: number;
755
791
  /**
756
- * When the developer replied.
792
+ * filtered / (relevant + filtered); null with nothing scored.
757
793
  */
758
- responseAt: string | null;
794
+ noiseShare: number | null;
759
795
  /**
760
- * The app reviewed.
796
+ * This keyword's share of the workspace's matches in the window; null when the workspace matched nothing.
761
797
  */
762
- app: {
798
+ workspaceShare: number | null;
799
+ /**
800
+ * 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.
801
+ */
802
+ judgedSince: string | null;
803
+ /**
804
+ * One row per platform it matched on, most matches first.
805
+ */
806
+ byPlatform: Array<{
763
807
  /**
764
- * appstore (Apple App Store), googleplay (Google Play), trustpilot (a company's Trustpilot page) or googlemaps (a place's Google reviews).
808
+ * 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).
765
809
  */
766
- platform: 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
810
+ platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
767
811
  /**
768
- * The store's app id.
812
+ * Matches on this platform in the window.
769
813
  */
770
- id: string;
814
+ matches: number;
771
815
  /**
772
- * The app's store listing.
816
+ * Of those, scored at or above the relevance line (40).
773
817
  */
774
- url: string;
775
- };
776
- } | null;
777
- /**
778
- * The classifier verdict, as corrected by your feedback; null while the post is still queued for classification.
779
- */
780
- classification: {
818
+ relevant: number;
819
+ /**
820
+ * Of those, scored under the line: the noise.
821
+ */
822
+ filtered: number;
823
+ /**
824
+ * filtered / (relevant + filtered); null with nothing scored.
825
+ */
826
+ noiseShare: number | null;
827
+ }>;
781
828
  /**
782
- * 0 to 100; null only when classification failed.
829
+ * The trend, one row per 7 days of the window, oldest first; the last row may be shorter.
783
830
  */
784
- relevance: number | null;
785
- /**
786
- * Classifier sentiment.
831
+ weekly: Array<{
832
+ /**
833
+ * First day of the 7, YYYY-MM-DD (counted from the window's first day).
834
+ */
835
+ from: string;
836
+ /**
837
+ * Matches in those 7 days.
838
+ */
839
+ matches: number;
840
+ /**
841
+ * Of those, relevant.
842
+ */
843
+ relevant: number;
844
+ }>;
845
+ /**
846
+ * What the keyword cost over the window at list price.
847
+ */
848
+ cost: {
849
+ /**
850
+ * Days in the window the keyword was charged for.
851
+ */
852
+ keywordDays: number;
853
+ /**
854
+ * Those days at the keyword rate.
855
+ */
856
+ keywordCents: number;
857
+ /**
858
+ * Matches billed in the window, by the time they were scored.
859
+ */
860
+ billableMentions: number;
861
+ /**
862
+ * Those matches at the mention rate.
863
+ */
864
+ mentionCents: number;
865
+ /**
866
+ * keywordCents plus mentionCents: its row in GET /v1/usage/breakdown for the same range.
867
+ */
868
+ totalCents: number;
869
+ };
870
+ };
871
+ /**
872
+ * The posts behind noiseTerms, noiseAuthors and the effects, after the keyword's current rules (a post an older rule let in is not counted). Review platforms are matched by app, not by text, and are left out.
873
+ */
874
+ sample: {
875
+ /**
876
+ * Noise posts read (the newest of the window, or since stats.judgedSince, at most 200), on platforms matched by text. None under 20 scored matches since a change.
877
+ */
878
+ noise: number;
879
+ /**
880
+ * Relevant posts read, likewise.
881
+ */
882
+ relevant: number;
883
+ };
884
+ /**
885
+ * Up to 10 words or phrases over-represented in the noise against the relevant posts, strongest first. The keyword's own words are left out.
886
+ */
887
+ noiseTerms: Array<{
888
+ /**
889
+ * A word or two-word phrase.
890
+ */
891
+ term: string;
892
+ /**
893
+ * Sampled noise posts that carry it.
894
+ */
895
+ noisePosts: number;
896
+ /**
897
+ * Sampled relevant posts that carry it.
898
+ */
899
+ relevantPosts: number;
900
+ /**
901
+ * How many times more common it is in noise than in relevant posts (smoothed); null with no relevant post to compare.
902
+ */
903
+ lift: number | null;
904
+ }>;
905
+ /**
906
+ * Authors with 3 or more noise posts in the sample and no relevant one.
907
+ */
908
+ noiseAuthors: Array<{
909
+ /**
910
+ * The author as the platform shows them.
911
+ */
912
+ name: string;
913
+ /**
914
+ * What matching.excludedAuthors would store for them.
915
+ */
916
+ entry: string;
917
+ /**
918
+ * Sampled noise posts by them.
919
+ */
920
+ noisePosts: number;
921
+ }>;
922
+ /**
923
+ * Changes that would cut the noise, each ready for PATCH /v1/keywords/{id}. Empty when nothing is worth changing, or under 20 scored matches since the last change (a reason says so).
924
+ */
925
+ suggestions: Array<KeywordSuggestion>;
926
+ /**
927
+ * The optional language model half of the report.
928
+ */
929
+ ai: {
930
+ /**
931
+ * ai=true was asked.
932
+ */
933
+ requested: boolean;
934
+ /**
935
+ * off: not asked. generated: written now. cached: written earlier today for the same keyword, window and settings. unavailable: the model failed, answered nothing usable or is not configured. rate_limited: the workspace's 20 model calls this hour are spent.
936
+ */
937
+ status: 'off' | 'generated' | 'cached' | 'unavailable' | 'rate_limited';
938
+ };
939
+ /**
940
+ * When the report was computed; it is cached for 5 minutes, and a change to the keyword starts a fresh one.
941
+ */
942
+ generatedAt: string;
943
+ };
944
+ /**
945
+ * Workspace-wide matching rules; a rejected post is never billed.
946
+ */
947
+ type WorkspaceFilters = {
948
+ /**
949
+ * A post containing any of these is dropped, whatever keyword matched it. Same phrase rule as a keyword; a `*` at an end is a wildcard. "hiring, job, careers" is the classic list.
950
+ */
951
+ excludedTerms: Array<string>;
952
+ /**
953
+ * Posts by these authors are dropped everywhere: your own accounts, employees, known spammers. Profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form.
954
+ */
955
+ excludedAuthors: Array<string>;
956
+ /**
957
+ * GitHub repositories whose issues, pull requests and comments are dropped, as owner/name or a github.com link (facebook/react, https://github.com/facebook/react).
958
+ */
959
+ excludedRepos: Array<string>;
960
+ /**
961
+ * Reddit only.
962
+ */
963
+ subreddits: {
964
+ /**
965
+ * When non-empty, ONLY Reddit posts from these subreddits pass and `excluded` is ignored. r/name or name.
966
+ */
967
+ only: Array<string>;
968
+ /**
969
+ * Reddit posts from these subreddits are dropped. r/name or name.
970
+ */
971
+ excluded: Array<string>;
972
+ };
973
+ /**
974
+ * Last edit; null until the first.
975
+ */
976
+ updatedAt: string | null;
977
+ };
978
+ type Mention = {
979
+ /**
980
+ * Mention id (mm_...): one post matched to one of your keywords. A post matching two keywords has two ids.
981
+ */
982
+ id: string;
983
+ /**
984
+ * open: nobody handled it yet. ignored: hidden from the feed and channels by you. done: handled.
985
+ */
986
+ status: 'open' | 'ignored' | 'done';
987
+ /**
988
+ * The classifier scored it at or above the delivery threshold (40).
989
+ */
990
+ relevant: boolean;
991
+ /**
992
+ * Reached at least one of your channels.
993
+ */
994
+ delivered: boolean;
995
+ /**
996
+ * Attention score, one decimal, computed at read time: relevance halved, author reach on a follower ladder (unknown reach counts 8), the strongest intent (buy intent 20 down to praise 5), minus 2 per day of age floored at 20.
997
+ */
998
+ priority: number;
999
+ /**
1000
+ * The keyword this post matched, and the group it is in.
1001
+ */
1002
+ keyword: {
1003
+ /**
1004
+ * Keyword id (kw_...).
1005
+ */
1006
+ id: string;
1007
+ /**
1008
+ * The tracked term.
1009
+ */
1010
+ term: string;
1011
+ group: GroupRef;
1012
+ };
1013
+ post: {
1014
+ /**
1015
+ * 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).
1016
+ */
1017
+ platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
1018
+ /**
1019
+ * Permalink of the post.
1020
+ */
1021
+ url: string;
1022
+ /**
1023
+ * Title and body, truncated to 8 KB at ingest.
1024
+ */
1025
+ text: string;
1026
+ /**
1027
+ * 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.
1028
+ */
1029
+ title: string | null;
1030
+ /**
1031
+ * A preview image of the post, when the platform sent one with it: a YouTube thumbnail, a DEV cover, a news article's sharing image, a Bluesky link card or image. Null otherwise.
1032
+ */
1033
+ imageUrl: string | null;
1034
+ /**
1035
+ * Links the post carries, in the order written, at most 20. Empty for a post with none, and for posts ingested before September 2026.
1036
+ */
1037
+ links: Array<string>;
1038
+ /**
1039
+ * When the post was published.
1040
+ */
1041
+ publishedAt: string;
1042
+ /**
1043
+ * 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.
1044
+ */
1045
+ engagement: {
1046
+ likes: number | null;
1047
+ reposts: number | null;
1048
+ replies: number | null;
1049
+ quotes: number | null;
1050
+ views: number | null;
1051
+ bookmarks: number | null;
1052
+ } | null;
1053
+ /**
1054
+ * The post this one replies to (X, Bluesky); null for top-level posts.
1055
+ */
1056
+ replyTo: {
1057
+ /**
1058
+ * Parent post author as the platform names them.
1059
+ */
1060
+ author: string | null;
1061
+ /**
1062
+ * Parent post URL.
1063
+ */
1064
+ url: string | null;
1065
+ /**
1066
+ * Parent post text, when the platform gave it.
1067
+ */
1068
+ text: string | null;
1069
+ } | null;
1070
+ };
1071
+ /**
1072
+ * Who posted it; null when the platform gave no author at all.
1073
+ */
1074
+ author: {
1075
+ /**
1076
+ * Person id (aut_...) for GET /v1/people/{id}; null when the account is not in the audience yet.
1077
+ */
1078
+ id: string | null;
1079
+ /**
1080
+ * Display name as the platform reports it.
1081
+ */
1082
+ name: string | null;
1083
+ /**
1084
+ * Platform handle derived from the profile URL, formatted as the platform shows it (@name, u/name); null where the platform has none.
1085
+ */
1086
+ handle: string | null;
1087
+ /**
1088
+ * Profile URL.
1089
+ */
1090
+ url: string | null;
1091
+ /**
1092
+ * Profile picture; null where the platform has none.
1093
+ */
1094
+ avatarUrl: string | null;
1095
+ /**
1096
+ * Follower count as of their newest post; null where the platform has none.
1097
+ */
1098
+ followers: number | null;
1099
+ /**
1100
+ * Your workspace tags on this person.
1101
+ */
1102
+ tags: Array<string>;
1103
+ } | null;
1104
+ /**
1105
+ * An app store review's facts; null for every other post. Its sentiment comes from the stars (4 and 5 positive, 3 neutral, 1 and 2 negative) and it always counts as relevant, since you chose the app.
1106
+ */
1107
+ review: {
1108
+ /**
1109
+ * Stars the reviewer gave.
1110
+ */
1111
+ rating: number;
1112
+ /**
1113
+ * The top of the scale: 5 on both stores.
1114
+ */
1115
+ ratingMax: number;
1116
+ /**
1117
+ * The review's headline; null where the store has none (Google Play).
1118
+ */
1119
+ title: string | null;
1120
+ /**
1121
+ * The app version the reviewer ran, when the store says.
1122
+ */
1123
+ version: string | null;
1124
+ /**
1125
+ * The storefront it was read in (App Store, Google Play) or the reviewer's country (Trustpilot), a lowercase two-letter code; null where the platform gives none.
1126
+ */
1127
+ country: string | null;
1128
+ /**
1129
+ * The platform marks the review as verified (Trustpilot); null where the platform has no such mark.
1130
+ */
1131
+ verified: boolean | null;
1132
+ /**
1133
+ * The developer's reply as it stood when the review was collected; null for none.
1134
+ */
1135
+ response: string | null;
1136
+ /**
1137
+ * When the developer replied.
1138
+ */
1139
+ responseAt: string | null;
1140
+ /**
1141
+ * The app reviewed.
1142
+ */
1143
+ app: {
1144
+ /**
1145
+ * appstore (Apple App Store), googleplay (Google Play), trustpilot (a company's Trustpilot page) or googlemaps (a place's Google reviews).
1146
+ */
1147
+ platform: 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
1148
+ /**
1149
+ * The store's app id.
1150
+ */
1151
+ id: string;
1152
+ /**
1153
+ * The app's store listing.
1154
+ */
1155
+ url: string;
1156
+ };
1157
+ } | null;
1158
+ /**
1159
+ * The classifier verdict, as corrected by your feedback; null while the post is still queued for classification.
1160
+ */
1161
+ classification: {
1162
+ /**
1163
+ * 0 to 100; null only when classification failed.
1164
+ */
1165
+ relevance: number | null;
1166
+ /**
1167
+ * Classifier sentiment.
787
1168
  */
788
1169
  sentiment: 'positive' | 'neutral' | 'negative';
789
1170
  /**
790
- * Intent and topic tags: buy_intent, question, complaint, praise, comparison, churn_intent (leaving or replacing the keyword), bug_report, pricing, hiring, event, promotional.
1171
+ * 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).
791
1172
  */
792
1173
  intents: Array<string>;
793
1174
  /**
@@ -1140,6 +1521,151 @@ type Segment = {
1140
1521
  */
1141
1522
  updatedAt: string;
1142
1523
  };
1524
+ /**
1525
+ * A group of conditions, all of which must hold: the vocabulary of a view filter, without anyOf.
1526
+ */
1527
+ type FilterGroup = {
1528
+ /**
1529
+ * Substring in the post text or the author's name.
1530
+ */
1531
+ q?: string;
1532
+ /**
1533
+ * Only matches of any of these keywords.
1534
+ */
1535
+ keywordIds?: Array<string>;
1536
+ /**
1537
+ * Never matches of these keywords.
1538
+ */
1539
+ notKeywordIds?: Array<string>;
1540
+ /**
1541
+ * Only matches of keywords of any of these kinds: brand, competitor, topic.
1542
+ */
1543
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
1544
+ /**
1545
+ * Only matches of keywords in any of these groups (grp_...).
1546
+ */
1547
+ groupIds?: Array<string>;
1548
+ /**
1549
+ * Never matches of keywords in these groups.
1550
+ */
1551
+ notGroupIds?: Array<string>;
1552
+ /**
1553
+ * Only posts from any of these platforms.
1554
+ */
1555
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
1556
+ /**
1557
+ * Never posts from these platforms.
1558
+ */
1559
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
1560
+ /**
1561
+ * Only mentions in this status: open, ignored, done.
1562
+ */
1563
+ status?: 'open' | 'ignored' | 'done';
1564
+ /**
1565
+ * true: only mentions the classifier scored relevant; false: only the rest.
1566
+ */
1567
+ relevant?: boolean;
1568
+ /**
1569
+ * Only mentions scored at least this.
1570
+ */
1571
+ minRelevance?: number;
1572
+ /**
1573
+ * Only mentions whose classifier confidence is at least this.
1574
+ */
1575
+ minConfidence?: number;
1576
+ /**
1577
+ * Only these sentiments.
1578
+ */
1579
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
1580
+ /**
1581
+ * Never these sentiments; an unscored mention still passes.
1582
+ */
1583
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
1584
+ /**
1585
+ * Only mentions carrying any of these intent or topic tags.
1586
+ */
1587
+ intents?: Array<string>;
1588
+ /**
1589
+ * Never mentions carrying these tags.
1590
+ */
1591
+ notIntents?: Array<string>;
1592
+ /**
1593
+ * true: only posts that read as machine-made; false: only the rest.
1594
+ */
1595
+ automated?: boolean;
1596
+ /**
1597
+ * Only posts in any of these languages (ISO 639-1).
1598
+ */
1599
+ languages?: Array<string>;
1600
+ /**
1601
+ * Never posts in these languages; an unknown language still passes.
1602
+ */
1603
+ notLanguages?: Array<string>;
1604
+ /**
1605
+ * Only authors your workspace tagged with any of these.
1606
+ */
1607
+ tags?: Array<string>;
1608
+ /**
1609
+ * Never authors tagged with any of these.
1610
+ */
1611
+ notTags?: Array<string>;
1612
+ /**
1613
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it.
1614
+ */
1615
+ linkHosts?: Array<string>;
1616
+ /**
1617
+ * Never posts linking to these hosts.
1618
+ */
1619
+ notLinkHosts?: Array<string>;
1620
+ /**
1621
+ * Only authors with at least this many followers; unknown reach never passes.
1622
+ */
1623
+ minFollowers?: number;
1624
+ /**
1625
+ * Only authors with at most this many followers; unknown reach never passes.
1626
+ */
1627
+ maxFollowers?: number;
1628
+ /**
1629
+ * true: only replies and comments; false: only top-level posts.
1630
+ */
1631
+ isReply?: boolean;
1632
+ /**
1633
+ * Never these authors: display names, handles or profile URLs.
1634
+ */
1635
+ excludeAuthors?: Array<string>;
1636
+ /**
1637
+ * Only app store reviews with any of these star ratings; every other post fails it.
1638
+ */
1639
+ ratings?: Array<number>;
1640
+ /**
1641
+ * Never reviews with these star ratings; posts that are not reviews still pass.
1642
+ */
1643
+ notRatings?: Array<number>;
1644
+ /**
1645
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
1646
+ */
1647
+ minLikes?: number;
1648
+ /**
1649
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
1650
+ */
1651
+ minReposts?: number;
1652
+ /**
1653
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
1654
+ */
1655
+ minReplies?: number;
1656
+ /**
1657
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
1658
+ */
1659
+ minQuotes?: number;
1660
+ /**
1661
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
1662
+ */
1663
+ minViews?: number;
1664
+ /**
1665
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
1666
+ */
1667
+ minBookmarks?: number;
1668
+ };
1143
1669
  type View = {
1144
1670
  /**
1145
1671
  * View id (vw_...).
@@ -1260,6 +1786,38 @@ type View = {
1260
1786
  * Only app store reviews with any of these star ratings; every other post fails it.
1261
1787
  */
1262
1788
  ratings?: Array<number>;
1789
+ /**
1790
+ * Never reviews with these star ratings; posts that are not reviews still pass.
1791
+ */
1792
+ notRatings?: Array<number>;
1793
+ /**
1794
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
1795
+ */
1796
+ minLikes?: number;
1797
+ /**
1798
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
1799
+ */
1800
+ minReposts?: number;
1801
+ /**
1802
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
1803
+ */
1804
+ minReplies?: number;
1805
+ /**
1806
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
1807
+ */
1808
+ minQuotes?: number;
1809
+ /**
1810
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
1811
+ */
1812
+ minViews?: number;
1813
+ /**
1814
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
1815
+ */
1816
+ minBookmarks?: number;
1817
+ /**
1818
+ * 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.
1819
+ */
1820
+ anyOf?: Array<FilterGroup>;
1263
1821
  };
1264
1822
  /**
1265
1823
  * ISO 8601 timestamp, UTC.
@@ -1937,6 +2495,38 @@ type Alert = {
1937
2495
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
1938
2496
  */
1939
2497
  ratings?: Array<number>;
2498
+ /**
2499
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
2500
+ */
2501
+ notRatings?: Array<number>;
2502
+ /**
2503
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
2504
+ */
2505
+ minLikes?: number;
2506
+ /**
2507
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
2508
+ */
2509
+ minReposts?: number;
2510
+ /**
2511
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
2512
+ */
2513
+ minReplies?: number;
2514
+ /**
2515
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
2516
+ */
2517
+ minQuotes?: number;
2518
+ /**
2519
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
2520
+ */
2521
+ minViews?: number;
2522
+ /**
2523
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
2524
+ */
2525
+ minBookmarks?: number;
2526
+ /**
2527
+ * 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.
2528
+ */
2529
+ anyOf?: Array<FilterGroup>;
1940
2530
  };
1941
2531
  /**
1942
2532
  * Daily and weekly alerts only.
@@ -2998,7 +3588,7 @@ type ListKeywordsData = {
2998
3588
  /**
2999
3589
  * Only keywords in these states: active, muted, paused, capped. Repeatable, or comma-separated.
3000
3590
  */
3001
- status?: Array<'active' | 'muted' | 'paused' | 'capped'>;
3591
+ status?: Array<'active' | 'muted' | 'paused' | 'noisy' | 'capped'>;
3002
3592
  /**
3003
3593
  * 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.
3004
3594
  */
@@ -3042,13 +3632,17 @@ type ListKeywordsResponses = {
3042
3632
  term: string;
3043
3633
  kind: 'brand' | 'competitor' | 'topic';
3044
3634
  /**
3045
- * Not polled or matched. Either paused by you or by the wallet (see pausedForBalance). A keyword at its mention cap is not muted (see pausedForCap).
3635
+ * Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
3046
3636
  */
3047
3637
  muted: boolean;
3048
3638
  /**
3049
3639
  * Muted by the wallet for lack of balance; a top-up resumes it, unmuting by hand needs balance too.
3050
3640
  */
3051
3641
  pausedForBalance: boolean;
3642
+ /**
3643
+ * 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.
3644
+ */
3645
+ pausedForNoise: boolean;
3052
3646
  /**
3053
3647
  * At its monthly mention cap: not matched until the first of next month (UTC) or until the cap is raised. Not muted: it keeps its place and its daily keyword charge.
3054
3648
  */
@@ -3061,6 +3655,14 @@ type ListKeywordsResponses = {
3061
3655
  * Matched mentions allowed per calendar month (UTC). Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
3062
3656
  */
3063
3657
  mentions: number;
3658
+ /**
3659
+ * Set by Mentio, not you: a workspace on its welcome credit collects at most 200 mentions a keyword a month. The first top-up removes it.
3660
+ */
3661
+ welcome: boolean;
3662
+ /**
3663
+ * Your own cap. With welcome true, the cap the keyword gets back at the first top-up (null for none); otherwise the same as mentions. Sending mentions: 200 back while welcome is true changes nothing.
3664
+ */
3665
+ own: number | null;
3064
3666
  } | null;
3065
3667
  group: GroupRef;
3066
3668
  /**
@@ -3154,6 +3756,10 @@ type ListKeywordsResponses = {
3154
3756
  */
3155
3757
  noisy: boolean;
3156
3758
  };
3759
+ /**
3760
+ * 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.
3761
+ */
3762
+ health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
3157
3763
  /**
3158
3764
  * 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.
3159
3765
  */
@@ -3466,31 +4072,77 @@ type UpdateKeywordData = {
3466
4072
  */
3467
4073
  id: string;
3468
4074
  };
3469
- query?: never;
3470
- url: '/v1/keywords/{id}';
4075
+ query?: never;
4076
+ url: '/v1/keywords/{id}';
4077
+ };
4078
+ type UpdateKeywordErrors = {
4079
+ /**
4080
+ * Missing or invalid API key
4081
+ */
4082
+ 401: ErrorResponse;
4083
+ /**
4084
+ * Unmuting needs balance for one more keyword-day (insufficient_balance) or would exceed the 500-keyword ceiling (keyword_limit_reached)
4085
+ */
4086
+ 402: ErrorResponse;
4087
+ /**
4088
+ * Keyword not found
4089
+ */
4090
+ 404: ErrorResponse;
4091
+ };
4092
+ type UpdateKeywordError = UpdateKeywordErrors[keyof UpdateKeywordErrors];
4093
+ type UpdateKeywordResponses = {
4094
+ /**
4095
+ * The updated keyword
4096
+ */
4097
+ 200: Keyword;
4098
+ };
4099
+ type UpdateKeywordResponse = UpdateKeywordResponses[keyof UpdateKeywordResponses];
4100
+ type GetKeywordHealthData = {
4101
+ body?: never;
4102
+ path: {
4103
+ /**
4104
+ * Keyword id (kw_...).
4105
+ */
4106
+ id: string;
4107
+ };
4108
+ query?: {
4109
+ /**
4110
+ * Trailing window of UTC days ending today, by match time: 7d, 30d, 90d (default 30d).
4111
+ */
4112
+ range?: '7d' | '30d' | '90d';
4113
+ /**
4114
+ * true: also ask a language model for a rewritten context (cached a day per keyword and window, at most 20 model calls an hour per workspace). Default false: every suggestion comes from the rules alone.
4115
+ */
4116
+ ai?: boolean;
4117
+ };
4118
+ url: '/v1/keywords/{id}/health';
3471
4119
  };
3472
- type UpdateKeywordErrors = {
4120
+ type GetKeywordHealthErrors = {
3473
4121
  /**
3474
- * Missing or invalid API key
4122
+ * Invalid query parameters
3475
4123
  */
3476
- 401: ErrorResponse;
4124
+ 400: ErrorResponse;
3477
4125
  /**
3478
- * Unmuting needs balance for one more keyword-day (insufficient_balance) or would exceed the 500-keyword ceiling (keyword_limit_reached)
4126
+ * Missing or invalid API key
3479
4127
  */
3480
- 402: ErrorResponse;
4128
+ 401: ErrorResponse;
3481
4129
  /**
3482
4130
  * Keyword not found
3483
4131
  */
3484
4132
  404: ErrorResponse;
4133
+ /**
4134
+ * More than 30 health reads this minute (rate_limited)
4135
+ */
4136
+ 429: ErrorResponse;
3485
4137
  };
3486
- type UpdateKeywordError = UpdateKeywordErrors[keyof UpdateKeywordErrors];
3487
- type UpdateKeywordResponses = {
4138
+ type GetKeywordHealthError = GetKeywordHealthErrors[keyof GetKeywordHealthErrors];
4139
+ type GetKeywordHealthResponses = {
3488
4140
  /**
3489
- * The updated keyword
4141
+ * The keyword's health report
3490
4142
  */
3491
- 200: Keyword;
4143
+ 200: KeywordHealth;
3492
4144
  };
3493
- type UpdateKeywordResponse = UpdateKeywordResponses[keyof UpdateKeywordResponses];
4145
+ type GetKeywordHealthResponse = GetKeywordHealthResponses[keyof GetKeywordHealthResponses];
3494
4146
  type GetFiltersData = {
3495
4147
  body?: never;
3496
4148
  path?: never;
@@ -3599,66 +4251,301 @@ type UpdateMentionData = {
3599
4251
  */
3600
4252
  body: {
3601
4253
  /**
3602
- * ignored or done to handle it; open to put it back.
4254
+ * ignored or done to handle it; open to put it back.
4255
+ */
4256
+ status?: 'open' | 'ignored' | 'done';
4257
+ /**
4258
+ * A workspace member (user id), or null to unassign.
4259
+ */
4260
+ assigneeId?: string | null;
4261
+ /**
4262
+ * ISO 8601 (or epoch ms) until which the mention leaves the feed; null wakes it.
4263
+ */
4264
+ snoozedUntil?: string;
4265
+ /**
4266
+ * Internal note; null or empty clears it.
4267
+ */
4268
+ note?: string | null;
4269
+ /**
4270
+ * 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.
4271
+ */
4272
+ relevant?: boolean | null;
4273
+ /**
4274
+ * Your corrected sentiment; null withdraws the correction and restores the classifier's.
4275
+ */
4276
+ sentiment?: 'positive' | 'neutral' | 'negative';
4277
+ };
4278
+ path: {
4279
+ /**
4280
+ * Mention id (mm_...).
4281
+ */
4282
+ id: string;
4283
+ };
4284
+ query?: never;
4285
+ url: '/v1/mentions/{id}';
4286
+ };
4287
+ type UpdateMentionErrors = {
4288
+ /**
4289
+ * Assignee is not a member of this organization
4290
+ */
4291
+ 400: ErrorResponse;
4292
+ /**
4293
+ * Missing or invalid API key
4294
+ */
4295
+ 401: ErrorResponse;
4296
+ /**
4297
+ * Mention not found
4298
+ */
4299
+ 404: ErrorResponse;
4300
+ /**
4301
+ * A verdict on a mention the classifier has not scored yet (classification_pending)
4302
+ */
4303
+ 409: ErrorResponse;
4304
+ };
4305
+ type UpdateMentionError = UpdateMentionErrors[keyof UpdateMentionErrors];
4306
+ type UpdateMentionResponses = {
4307
+ /**
4308
+ * The updated mention
4309
+ */
4310
+ 200: Mention;
4311
+ };
4312
+ type UpdateMentionResponse = UpdateMentionResponses[keyof UpdateMentionResponses];
4313
+ type SearchMentionsData = {
4314
+ body?: never;
4315
+ path?: never;
4316
+ query?: {
4317
+ /**
4318
+ * Only matches of this keyword.
4319
+ */
4320
+ keywordId?: string;
4321
+ /**
4322
+ * Only posts from this platform.
4323
+ */
4324
+ platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
4325
+ /**
4326
+ * Only mentions in this status. Omit for every status.
4327
+ */
4328
+ status?: 'open' | 'ignored' | 'done';
4329
+ /**
4330
+ * true: only mentions the classifier scored relevant; false: only the rest (unclassified included).
4331
+ */
4332
+ relevant?: boolean;
4333
+ /**
4334
+ * Only this sentiment.
4335
+ */
4336
+ sentiment?: 'positive' | 'neutral' | 'negative';
4337
+ /**
4338
+ * 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).
4339
+ */
4340
+ intent?: string;
4341
+ /**
4342
+ * true: only mentions that read as machine-made (a bot account, a scheduled or templated post, AI-written text); false: only the rest, mentions judged before this existed included. Omitted: everything.
4343
+ */
4344
+ automated?: boolean;
4345
+ /**
4346
+ * Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
4347
+ */
4348
+ personId?: string;
4349
+ /**
4350
+ * true: include mentions by people you muted, hidden by default.
4351
+ */
4352
+ includeMuted?: boolean;
4353
+ /**
4354
+ * Only mentions assigned to this workspace member (user id).
4355
+ */
4356
+ assigneeId?: string;
4357
+ /**
4358
+ * true: only mentions currently snoozed. Otherwise snoozed mentions stay out until they wake.
4359
+ */
4360
+ snoozed?: boolean;
4361
+ /**
4362
+ * Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
4363
+ */
4364
+ excludeAuthors?: Array<string> | null;
4365
+ /**
4366
+ * Only mentions scored at least this; unclassified ones are excluded.
4367
+ */
4368
+ minRelevance?: number | null;
4369
+ /**
4370
+ * Only mentions whose classifier confidence is at least this, 0 to 1. Mentions without a confidence are excluded.
4371
+ */
4372
+ minConfidence?: number | null;
4373
+ /**
4374
+ * Only authors with at least this many followers. Unknown reach never passes.
4375
+ */
4376
+ minFollowers?: number | null;
4377
+ /**
4378
+ * Only authors with at most this many followers. Unknown reach never passes.
4379
+ */
4380
+ maxFollowers?: number | null;
4381
+ /**
4382
+ * true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
4383
+ */
4384
+ isReply?: boolean;
4385
+ /**
4386
+ * Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404.
4387
+ */
4388
+ alertId?: string;
4389
+ /**
4390
+ * Apply a saved view's filter (an id from GET /v1/views) on top of the other filters, every condition ANDed: exactly what the view selects. Unknown ids are a 404.
4391
+ */
4392
+ viewId?: string;
4393
+ /**
4394
+ * Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
4395
+ */
4396
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
4397
+ /**
4398
+ * Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
4399
+ */
4400
+ tags?: Array<string> | null;
4401
+ /**
4402
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). Repeatable, or comma-separated.
4403
+ */
4404
+ linkHosts?: Array<string> | null;
4405
+ /**
4406
+ * Only posts from any of these platforms.
4407
+ */
4408
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
4409
+ /**
4410
+ * Never posts from these platforms.
4411
+ */
4412
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
4413
+ /**
4414
+ * Only matches of any of these keywords.
4415
+ */
4416
+ keywordIds?: Array<string> | null;
4417
+ /**
4418
+ * Only matches of keywords in any of these groups (grp_...). Repeatable, or comma-separated.
4419
+ */
4420
+ groupIds?: Array<string> | null;
4421
+ /**
4422
+ * Never matches of keywords in these groups.
4423
+ */
4424
+ notGroupIds?: Array<string> | null;
4425
+ /**
4426
+ * Never matches of these keywords.
4427
+ */
4428
+ notKeywordIds?: Array<string> | null;
4429
+ /**
4430
+ * Only these sentiments.
4431
+ */
4432
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
4433
+ /**
4434
+ * Never these sentiments. A mention the classifier has not scored yet still passes.
4435
+ */
4436
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
4437
+ /**
4438
+ * Only mentions carrying any of these intent or topic tags.
4439
+ */
4440
+ intents?: Array<string> | null;
4441
+ /**
4442
+ * Never mentions carrying these intent or topic tags.
4443
+ */
4444
+ notIntents?: Array<string> | null;
4445
+ /**
4446
+ * Never posts linking to these hosts, the host itself or a subdomain of it.
4447
+ */
4448
+ notLinkHosts?: Array<string> | null;
4449
+ /**
4450
+ * Never authors your workspace tagged with any of these.
4451
+ */
4452
+ notTags?: Array<string> | null;
4453
+ /**
4454
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
4455
+ */
4456
+ languages?: Array<string>;
4457
+ /**
4458
+ * Never posts in these languages. A post whose language is unknown still passes.
4459
+ */
4460
+ notLanguages?: Array<string>;
4461
+ /**
4462
+ * Only app store reviews with any of these star ratings (1 to 5): ratings=1,2 is the unhappy ones. Every other post fails it.
4463
+ */
4464
+ ratings?: Array<number>;
4465
+ /**
4466
+ * Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
4467
+ */
4468
+ notRatings?: Array<number>;
4469
+ /**
4470
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
4471
+ */
4472
+ minLikes?: number | null;
4473
+ /**
4474
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
4475
+ */
4476
+ minReposts?: number | null;
4477
+ /**
4478
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
4479
+ */
4480
+ minReplies?: number | null;
4481
+ /**
4482
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
4483
+ */
4484
+ minQuotes?: number | null;
4485
+ /**
4486
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
4487
+ */
4488
+ minViews?: number | null;
4489
+ /**
4490
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
3603
4491
  */
3604
- status?: 'open' | 'ignored' | 'done';
4492
+ minBookmarks?: number | null;
3605
4493
  /**
3606
- * A workspace member (user id), or null to unassign.
4494
+ * 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.
3607
4495
  */
3608
- assigneeId?: string | null;
4496
+ anyOf?: string;
3609
4497
  /**
3610
- * ISO 8601 (or epoch ms) until which the mention leaves the feed; null wakes it.
4498
+ * Substring search in the post text or the author's name.
3611
4499
  */
3612
- snoozedUntil?: string;
4500
+ q?: string;
3613
4501
  /**
3614
- * Internal note; null or empty clears it.
4502
+ * Only posts published at or after this instant (ISO 8601, or epoch ms).
3615
4503
  */
3616
- note?: string | null;
4504
+ since?: string;
3617
4505
  /**
3618
- * 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.
4506
+ * Only posts published at or before this instant (ISO 8601, or epoch ms).
3619
4507
  */
3620
- relevant?: boolean | null;
4508
+ until?: string;
3621
4509
  /**
3622
- * Your corrected sentiment; null withdraws the correction and restores the classifier's.
4510
+ * newest: by match time, newest first. priority: by attention score, highest first; priority ranks the last 30 days of matches only, older ones stay reachable under newest. Cursors are specific to a sort.
3623
4511
  */
3624
- sentiment?: 'positive' | 'neutral' | 'negative';
3625
- };
3626
- path: {
4512
+ sort?: 'newest' | 'priority';
3627
4513
  /**
3628
- * Mention id (mm_...).
4514
+ * nextCursor from the previous page; pass the same filters and sort.
3629
4515
  */
3630
- id: string;
4516
+ cursor?: string;
4517
+ /**
4518
+ * Page size, 1 to 100.
4519
+ */
4520
+ limit?: number;
3631
4521
  };
3632
- query?: never;
3633
- url: '/v1/mentions/{id}';
4522
+ url: '/v1/mentions';
3634
4523
  };
3635
- type UpdateMentionErrors = {
4524
+ type SearchMentionsErrors = {
3636
4525
  /**
3637
- * Assignee is not a member of this organization
4526
+ * Invalid query or pagination cursor, or filter_too_complex: the filters together (anyOf groups, a view or rule on top) name more values than one query can carry
3638
4527
  */
3639
4528
  400: ErrorResponse;
3640
4529
  /**
3641
4530
  * Missing or invalid API key
3642
4531
  */
3643
4532
  401: ErrorResponse;
3644
- /**
3645
- * Mention not found
3646
- */
3647
- 404: ErrorResponse;
3648
- /**
3649
- * A verdict on a mention the classifier has not scored yet (classification_pending)
3650
- */
3651
- 409: ErrorResponse;
3652
4533
  };
3653
- type UpdateMentionError = UpdateMentionErrors[keyof UpdateMentionErrors];
3654
- type UpdateMentionResponses = {
4534
+ type SearchMentionsError = SearchMentionsErrors[keyof SearchMentionsErrors];
4535
+ type SearchMentionsResponses = {
3655
4536
  /**
3656
- * The updated mention
4537
+ * One page of mentions in the requested order
3657
4538
  */
3658
- 200: Mention;
4539
+ 200: {
4540
+ data: Array<Mention>;
4541
+ /**
4542
+ * Pass as cursor for the next page; null on the last page.
4543
+ */
4544
+ nextCursor: string | null;
4545
+ };
3659
4546
  };
3660
- type UpdateMentionResponse = UpdateMentionResponses[keyof UpdateMentionResponses];
3661
- type SearchMentionsData = {
4547
+ type SearchMentionsResponse = SearchMentionsResponses[keyof SearchMentionsResponses];
4548
+ type ExportMentionsCsvData = {
3662
4549
  body?: never;
3663
4550
  path?: never;
3664
4551
  query?: {
@@ -3683,7 +4570,7 @@ type SearchMentionsData = {
3683
4570
  */
3684
4571
  sentiment?: 'positive' | 'neutral' | 'negative';
3685
4572
  /**
3686
- * Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
4573
+ * 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).
3687
4574
  */
3688
4575
  intent?: string;
3689
4576
  /**
@@ -3811,57 +4698,75 @@ type SearchMentionsData = {
3811
4698
  */
3812
4699
  ratings?: Array<number>;
3813
4700
  /**
3814
- * Substring search in the post text or the author's name.
4701
+ * Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
3815
4702
  */
3816
- q?: string;
4703
+ notRatings?: Array<number>;
3817
4704
  /**
3818
- * Only posts published at or after this instant (ISO 8601, or epoch ms).
4705
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
3819
4706
  */
3820
- since?: string;
4707
+ minLikes?: number | null;
3821
4708
  /**
3822
- * Only posts published at or before this instant (ISO 8601, or epoch ms).
4709
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
3823
4710
  */
3824
- until?: string;
4711
+ minReposts?: number | null;
3825
4712
  /**
3826
- * newest: by match time, newest first. priority: by attention score, highest first; priority ranks the last 30 days of matches only, older ones stay reachable under newest. Cursors are specific to a sort.
4713
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
3827
4714
  */
3828
- sort?: 'newest' | 'priority';
4715
+ minReplies?: number | null;
3829
4716
  /**
3830
- * nextCursor from the previous page; pass the same filters and sort.
4717
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
3831
4718
  */
3832
- cursor?: string;
4719
+ minQuotes?: number | null;
3833
4720
  /**
3834
- * Page size, 1 to 100.
4721
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
3835
4722
  */
3836
- limit?: number;
4723
+ minViews?: number | null;
4724
+ /**
4725
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
4726
+ */
4727
+ minBookmarks?: number | null;
4728
+ /**
4729
+ * 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.
4730
+ */
4731
+ anyOf?: string;
4732
+ /**
4733
+ * Substring search in the post text or the author's name.
4734
+ */
4735
+ q?: string;
4736
+ /**
4737
+ * Only posts published at or after this instant (ISO 8601, or epoch ms).
4738
+ */
4739
+ since?: string;
4740
+ /**
4741
+ * Only posts published at or before this instant (ISO 8601, or epoch ms).
4742
+ */
4743
+ until?: string;
3837
4744
  };
3838
- url: '/v1/mentions';
4745
+ url: '/v1/mentions/export.csv';
3839
4746
  };
3840
- type SearchMentionsErrors = {
4747
+ type ExportMentionsCsvErrors = {
3841
4748
  /**
3842
- * Invalid query or pagination cursor
4749
+ * Invalid query, or filter_too_complex: the filters together name more values than one query can carry
3843
4750
  */
3844
4751
  400: ErrorResponse;
3845
4752
  /**
3846
4753
  * Missing or invalid API key
3847
4754
  */
3848
4755
  401: ErrorResponse;
4756
+ /**
4757
+ * More than 6 exports this minute; retry after the Retry-After seconds
4758
+ */
4759
+ 429: ErrorResponse;
3849
4760
  };
3850
- type SearchMentionsError = SearchMentionsErrors[keyof SearchMentionsErrors];
3851
- type SearchMentionsResponses = {
4761
+ type ExportMentionsCsvError = ExportMentionsCsvErrors[keyof ExportMentionsCsvErrors];
4762
+ type ExportMentionsCsvResponses = {
3852
4763
  /**
3853
- * One page of mentions in the requested order
4764
+ * CSV, UTF-8
3854
4765
  */
3855
- 200: {
3856
- data: Array<Mention>;
3857
- /**
3858
- * Pass as cursor for the next page; null on the last page.
3859
- */
3860
- nextCursor: string | null;
3861
- };
4766
+ 200: string;
3862
4767
  };
3863
- type SearchMentionsResponse = SearchMentionsResponses[keyof SearchMentionsResponses];
3864
- type ExportMentionsCsvData = {
4768
+ type ExportMentionsCsvResponse = ExportMentionsCsvResponses[keyof ExportMentionsCsvResponses];
4769
+ type ExportMentionsJsonData = {
3865
4770
  body?: never;
3866
4771
  path?: never;
3867
4772
  query?: {
@@ -3886,7 +4791,7 @@ type ExportMentionsCsvData = {
3886
4791
  */
3887
4792
  sentiment?: 'positive' | 'neutral' | 'negative';
3888
4793
  /**
3889
- * Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
4794
+ * 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).
3890
4795
  */
3891
4796
  intent?: string;
3892
4797
  /**
@@ -4013,6 +4918,38 @@ type ExportMentionsCsvData = {
4013
4918
  * Only app store reviews with any of these star ratings (1 to 5): ratings=1,2 is the unhappy ones. Every other post fails it.
4014
4919
  */
4015
4920
  ratings?: Array<number>;
4921
+ /**
4922
+ * Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
4923
+ */
4924
+ notRatings?: Array<number>;
4925
+ /**
4926
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
4927
+ */
4928
+ minLikes?: number | null;
4929
+ /**
4930
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
4931
+ */
4932
+ minReposts?: number | null;
4933
+ /**
4934
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
4935
+ */
4936
+ minReplies?: number | null;
4937
+ /**
4938
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
4939
+ */
4940
+ minQuotes?: number | null;
4941
+ /**
4942
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
4943
+ */
4944
+ minViews?: number | null;
4945
+ /**
4946
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
4947
+ */
4948
+ minBookmarks?: number | null;
4949
+ /**
4950
+ * 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.
4951
+ */
4952
+ anyOf?: string;
4016
4953
  /**
4017
4954
  * Substring search in the post text or the author's name.
4018
4955
  */
@@ -4026,11 +4963,11 @@ type ExportMentionsCsvData = {
4026
4963
  */
4027
4964
  until?: string;
4028
4965
  };
4029
- url: '/v1/mentions/export.csv';
4966
+ url: '/v1/mentions/export.json';
4030
4967
  };
4031
- type ExportMentionsCsvErrors = {
4968
+ type ExportMentionsJsonErrors = {
4032
4969
  /**
4033
- * Invalid query
4970
+ * Invalid query, or filter_too_complex: the filters together name more values than one query can carry
4034
4971
  */
4035
4972
  400: ErrorResponse;
4036
4973
  /**
@@ -4042,14 +4979,23 @@ type ExportMentionsCsvErrors = {
4042
4979
  */
4043
4980
  429: ErrorResponse;
4044
4981
  };
4045
- type ExportMentionsCsvError = ExportMentionsCsvErrors[keyof ExportMentionsCsvErrors];
4046
- type ExportMentionsCsvResponses = {
4982
+ type ExportMentionsJsonError = ExportMentionsJsonErrors[keyof ExportMentionsJsonErrors];
4983
+ type ExportMentionsJsonResponses = {
4047
4984
  /**
4048
- * CSV, UTF-8
4985
+ * Every matching mention, up to the cap
4049
4986
  */
4050
- 200: string;
4987
+ 200: {
4988
+ /**
4989
+ * At most 10,000 mentions, newest matched first.
4990
+ */
4991
+ data: Array<Mention>;
4992
+ /**
4993
+ * true when more mentions matched than the cap returns: narrow the filters (since, until) and export again.
4994
+ */
4995
+ truncated: boolean;
4996
+ };
4051
4997
  };
4052
- type ExportMentionsCsvResponse = ExportMentionsCsvResponses[keyof ExportMentionsCsvResponses];
4998
+ type ExportMentionsJsonResponse = ExportMentionsJsonResponses[keyof ExportMentionsJsonResponses];
4053
4999
  type ExportPeopleCsvData = {
4054
5000
  body?: never;
4055
5001
  path?: never;
@@ -4062,6 +5008,10 @@ type ExportPeopleCsvData = {
4062
5008
  * Matches the display name or the profile handle or URL, case-insensitively.
4063
5009
  */
4064
5010
  q?: string;
5011
+ /**
5012
+ * Find a person by one of their accounts: a handle (@jane, u/jane, jane) or a profile or post link (https://x.com/jane). Exact, case-insensitive, merged accounts included; combine with platform to pick one platform. A link names its own platform.
5013
+ */
5014
+ handle?: string;
4065
5015
  /**
4066
5016
  * Only people carrying this tag (exact, case-sensitive).
4067
5017
  */
@@ -4191,6 +5141,10 @@ type ListPeopleData = {
4191
5141
  * Matches the display name or the profile handle or URL, case-insensitively.
4192
5142
  */
4193
5143
  q?: string;
5144
+ /**
5145
+ * Find a person by one of their accounts: a handle (@jane, u/jane, jane) or a profile or post link (https://x.com/jane). Exact, case-insensitive, merged accounts included; combine with platform to pick one platform. A link names its own platform.
5146
+ */
5147
+ handle?: string;
4194
5148
  /**
4195
5149
  * Only people carrying this tag (exact, case-sensitive).
4196
5150
  */
@@ -5371,6 +6325,38 @@ type ListViewsResponses = {
5371
6325
  * Only app store reviews with any of these star ratings; every other post fails it.
5372
6326
  */
5373
6327
  ratings?: Array<number>;
6328
+ /**
6329
+ * Never reviews with these star ratings; posts that are not reviews still pass.
6330
+ */
6331
+ notRatings?: Array<number>;
6332
+ /**
6333
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
6334
+ */
6335
+ minLikes?: number;
6336
+ /**
6337
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
6338
+ */
6339
+ minReposts?: number;
6340
+ /**
6341
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
6342
+ */
6343
+ minReplies?: number;
6344
+ /**
6345
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
6346
+ */
6347
+ minQuotes?: number;
6348
+ /**
6349
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
6350
+ */
6351
+ minViews?: number;
6352
+ /**
6353
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
6354
+ */
6355
+ minBookmarks?: number;
6356
+ /**
6357
+ * 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.
6358
+ */
6359
+ anyOf?: Array<FilterGroup>;
5374
6360
  };
5375
6361
  /**
5376
6362
  * ISO 8601 timestamp, UTC.
@@ -5510,6 +6496,38 @@ type CreateViewData = {
5510
6496
  * Only app store reviews with any of these star ratings; every other post fails it.
5511
6497
  */
5512
6498
  ratings?: Array<number>;
6499
+ /**
6500
+ * Never reviews with these star ratings; posts that are not reviews still pass.
6501
+ */
6502
+ notRatings?: Array<number>;
6503
+ /**
6504
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
6505
+ */
6506
+ minLikes?: number;
6507
+ /**
6508
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
6509
+ */
6510
+ minReposts?: number;
6511
+ /**
6512
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
6513
+ */
6514
+ minReplies?: number;
6515
+ /**
6516
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
6517
+ */
6518
+ minQuotes?: number;
6519
+ /**
6520
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
6521
+ */
6522
+ minViews?: number;
6523
+ /**
6524
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
6525
+ */
6526
+ minBookmarks?: number;
6527
+ /**
6528
+ * 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.
6529
+ */
6530
+ anyOf?: Array<FilterGroup>;
5513
6531
  };
5514
6532
  };
5515
6533
  path?: never;
@@ -5517,6 +6535,10 @@ type CreateViewData = {
5517
6535
  url: '/v1/views';
5518
6536
  };
5519
6537
  type CreateViewErrors = {
6538
+ /**
6539
+ * Invalid filter (an empty anyOf group, for one), or filter_too_complex: more values than one query can carry
6540
+ */
6541
+ 400: ErrorResponse;
5520
6542
  /**
5521
6543
  * Missing or invalid API key
5522
6544
  */
@@ -5712,6 +6734,38 @@ type UpdateViewData = {
5712
6734
  * Only app store reviews with any of these star ratings; every other post fails it.
5713
6735
  */
5714
6736
  ratings?: Array<number>;
6737
+ /**
6738
+ * Never reviews with these star ratings; posts that are not reviews still pass.
6739
+ */
6740
+ notRatings?: Array<number>;
6741
+ /**
6742
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
6743
+ */
6744
+ minLikes?: number;
6745
+ /**
6746
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
6747
+ */
6748
+ minReposts?: number;
6749
+ /**
6750
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
6751
+ */
6752
+ minReplies?: number;
6753
+ /**
6754
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
6755
+ */
6756
+ minQuotes?: number;
6757
+ /**
6758
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
6759
+ */
6760
+ minViews?: number;
6761
+ /**
6762
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
6763
+ */
6764
+ minBookmarks?: number;
6765
+ /**
6766
+ * 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.
6767
+ */
6768
+ anyOf?: Array<FilterGroup>;
5715
6769
  };
5716
6770
  };
5717
6771
  path: {
@@ -6706,6 +7760,38 @@ type UpdateAlertData = {
6706
7760
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
6707
7761
  */
6708
7762
  ratings?: Array<number>;
7763
+ /**
7764
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
7765
+ */
7766
+ notRatings?: Array<number>;
7767
+ /**
7768
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
7769
+ */
7770
+ minLikes?: number;
7771
+ /**
7772
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
7773
+ */
7774
+ minReposts?: number;
7775
+ /**
7776
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
7777
+ */
7778
+ minReplies?: number;
7779
+ /**
7780
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
7781
+ */
7782
+ minQuotes?: number;
7783
+ /**
7784
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
7785
+ */
7786
+ minViews?: number;
7787
+ /**
7788
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
7789
+ */
7790
+ minBookmarks?: number;
7791
+ /**
7792
+ * 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.
7793
+ */
7794
+ anyOf?: Array<FilterGroup>;
6709
7795
  };
6710
7796
  schedule?: {
6711
7797
  hour: number;
@@ -6840,6 +7926,38 @@ type ListAlertsResponses = {
6840
7926
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
6841
7927
  */
6842
7928
  ratings?: Array<number>;
7929
+ /**
7930
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
7931
+ */
7932
+ notRatings?: Array<number>;
7933
+ /**
7934
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
7935
+ */
7936
+ minLikes?: number;
7937
+ /**
7938
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
7939
+ */
7940
+ minReposts?: number;
7941
+ /**
7942
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
7943
+ */
7944
+ minReplies?: number;
7945
+ /**
7946
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
7947
+ */
7948
+ minQuotes?: number;
7949
+ /**
7950
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
7951
+ */
7952
+ minViews?: number;
7953
+ /**
7954
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
7955
+ */
7956
+ minBookmarks?: number;
7957
+ /**
7958
+ * 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.
7959
+ */
7960
+ anyOf?: Array<FilterGroup>;
6843
7961
  };
6844
7962
  /**
6845
7963
  * Daily and weekly alerts only.
@@ -6953,6 +8071,38 @@ type CreateAlertData = {
6953
8071
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
6954
8072
  */
6955
8073
  ratings?: Array<number>;
8074
+ /**
8075
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
8076
+ */
8077
+ notRatings?: Array<number>;
8078
+ /**
8079
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
8080
+ */
8081
+ minLikes?: number;
8082
+ /**
8083
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
8084
+ */
8085
+ minReposts?: number;
8086
+ /**
8087
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
8088
+ */
8089
+ minReplies?: number;
8090
+ /**
8091
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
8092
+ */
8093
+ minQuotes?: number;
8094
+ /**
8095
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
8096
+ */
8097
+ minViews?: number;
8098
+ /**
8099
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
8100
+ */
8101
+ minBookmarks?: number;
8102
+ /**
8103
+ * 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.
8104
+ */
8105
+ anyOf?: Array<FilterGroup>;
6956
8106
  };
6957
8107
  /**
6958
8108
  * Required for daily and weekly alerts (weekly ones also need schedule.weekday).
@@ -6982,7 +8132,7 @@ type CreateAlertData = {
6982
8132
  };
6983
8133
  type CreateAlertErrors = {
6984
8134
  /**
6985
- * A daily or weekly rule without a schedule (or a weekly one without a weekday), or an unknown channel
8135
+ * A daily or weekly rule without a schedule (or a weekly one without a weekday), an unknown channel, or anyOf groups binding more values than one query can carry (filter_too_complex)
6986
8136
  */
6987
8137
  400: ErrorResponse;
6988
8138
  /**
@@ -7776,6 +8926,12 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
7776
8926
  * 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.
7777
8927
  */
7778
8928
  declare const updateKeyword: <ThrowOnError extends boolean = false>(options: Options<UpdateKeywordData, ThrowOnError>) => RequestResult<UpdateKeywordResponses, UpdateKeywordErrors, ThrowOnError>;
8929
+ /**
8930
+ * Get a keyword's health
8931
+ *
8932
+ * 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.
8933
+ */
8934
+ declare const getKeywordHealth: <ThrowOnError extends boolean = false>(options: Options<GetKeywordHealthData, ThrowOnError>) => RequestResult<GetKeywordHealthResponses, GetKeywordHealthErrors, ThrowOnError>;
7779
8935
  /**
7780
8936
  * Get the workspace filters
7781
8937
  *
@@ -7803,15 +8959,21 @@ declare const updateMention: <ThrowOnError extends boolean = false>(options: Opt
7803
8959
  /**
7804
8960
  * List mentions
7805
8961
  *
7806
- * 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.
8962
+ * 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.
7807
8963
  */
7808
8964
  declare const searchMentions: <ThrowOnError extends boolean = false>(options?: Options<SearchMentionsData, ThrowOnError>) => RequestResult<SearchMentionsResponses, SearchMentionsErrors, ThrowOnError>;
7809
8965
  /**
7810
8966
  * Export mentions as CSV
7811
8967
  *
7812
- * 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). 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.
8968
+ * The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them). Capped at 10,000 rows; the X-Mentions-Truncated header says when the cap cut the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
7813
8969
  */
7814
8970
  declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
8971
+ /**
8972
+ * Export mentions as JSON
8973
+ *
8974
+ * 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.
8975
+ */
8976
+ declare const exportMentionsJson: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsJsonData, ThrowOnError>) => RequestResult<ExportMentionsJsonResponses, ExportMentionsJsonErrors, ThrowOnError>;
7815
8977
  /**
7816
8978
  * Export people as CSV
7817
8979
  *
@@ -7899,7 +9061,7 @@ declare const listViews: <ThrowOnError extends boolean = false>(options?: Option
7899
9061
  /**
7900
9062
  * Save a view
7901
9063
  *
7902
- * 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); an empty filter is every mention. Nothing is materialized: the view selects whatever matches when it is read.
9064
+ * 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.
7903
9065
  */
7904
9066
  declare const createView: <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => RequestResult<CreateViewResponses, CreateViewErrors, ThrowOnError>;
7905
9067
  /**
@@ -8071,7 +9233,7 @@ declare const listAlerts: <ThrowOnError extends boolean = false>(options?: Optio
8071
9233
  /**
8072
9234
  * Create an alert
8073
9235
  *
8074
- * A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday).
9236
+ * A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday). 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.
8075
9237
  */
8076
9238
  declare const createAlert: <ThrowOnError extends boolean = false>(options: Options<CreateAlertData, ThrowOnError>) => RequestResult<CreateAlertResponses, CreateAlertErrors, ThrowOnError>;
8077
9239
  /**
@@ -8175,6 +9337,7 @@ declare const sdk_deletePersonActivity: typeof deletePersonActivity;
8175
9337
  declare const sdk_deleteSegment: typeof deleteSegment;
8176
9338
  declare const sdk_deleteView: typeof deleteView;
8177
9339
  declare const sdk_exportMentionsCsv: typeof exportMentionsCsv;
9340
+ declare const sdk_exportMentionsJson: typeof exportMentionsJson;
8178
9341
  declare const sdk_exportPeopleCsv: typeof exportPeopleCsv;
8179
9342
  declare const sdk_getAlert: typeof getAlert;
8180
9343
  declare const sdk_getAnalyticsBreakdown: typeof getAnalyticsBreakdown;
@@ -8187,6 +9350,7 @@ declare const sdk_getGroup: typeof getGroup;
8187
9350
  declare const sdk_getHealth: typeof getHealth;
8188
9351
  declare const sdk_getInvoiceUrl: typeof getInvoiceUrl;
8189
9352
  declare const sdk_getKeyword: typeof getKeyword;
9353
+ declare const sdk_getKeywordHealth: typeof getKeywordHealth;
8190
9354
  declare const sdk_getMention: typeof getMention;
8191
9355
  declare const sdk_getPerson: typeof getPerson;
8192
9356
  declare const sdk_getReviewsReport: typeof getReviewsReport;
@@ -8235,7 +9399,7 @@ declare const sdk_updateSegment: typeof updateSegment;
8235
9399
  declare const sdk_updateView: typeof updateView;
8236
9400
  declare const sdk_whoami: typeof whoami;
8237
9401
  declare namespace sdk {
8238
- export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
9402
+ export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
8239
9403
  }
8240
9404
 
8241
9405
  /**
@@ -8263,4 +9427,4 @@ type Mentio = typeof sdk & {
8263
9427
  };
8264
9428
  declare function createMentio(options: MentioOptions): Mentio;
8265
9429
 
8266
- export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type Channel, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type 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 GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type Invitation, type InvoiceList, type Keyword, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, exportMentionsCsv, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
9430
+ export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type Channel, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type FilterGroup, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type Invitation, type InvoiceList, type Keyword, type KeywordHealth, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };