@mentio-dev/sdk 0.10.1 → 0.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -509,6 +509,10 @@ type Keyword = {
509
509
  */
510
510
  noisy: boolean;
511
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';
512
516
  /**
513
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.
514
518
  */
@@ -565,7 +569,7 @@ type ErrorResponse = {
565
569
  /**
566
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.
567
571
  */
568
- 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' | 'hourly_email_unsupported' | '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';
569
573
  /**
570
574
  * Human-readable detail; may change between releases.
571
575
  */
@@ -580,6 +584,363 @@ type ErrorResponse = {
580
584
  retryAfterSeconds?: number;
581
585
  };
582
586
  };
587
+ type KeywordSuggestion = {
588
+ /**
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.
590
+ */
591
+ type: 'excluded_terms' | 'excluded_authors' | 'required_terms' | 'platforms' | 'context';
592
+ /**
593
+ * What it adds (terms, authors), drops (platforms) or writes (the context).
594
+ */
595
+ values: Array<string>;
596
+ /**
597
+ * The reason and the measured effect, in plain words.
598
+ */
599
+ why: string;
600
+ /**
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.
602
+ */
603
+ patch: {
604
+ /**
605
+ * Reclassify it as brand, competitor or topic.
606
+ */
607
+ kind?: 'brand' | 'competitor' | 'topic';
608
+ /**
609
+ * A muted keyword stops polling and matching; its mentions stay.
610
+ */
611
+ muted?: boolean;
612
+ /**
613
+ * Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).
614
+ */
615
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram'> | null;
616
+ /**
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.
618
+ */
619
+ context?: string | null;
620
+ /**
621
+ * Omitted fields are untouched; an empty list clears one.
622
+ */
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
+ };
645
+ /**
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.
647
+ */
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;
654
+ /**
655
+ * Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
656
+ */
657
+ groupId?: string;
658
+ /**
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.
660
+ */
661
+ reviewSources?: Array<{
662
+ /**
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.
664
+ */
665
+ url?: string;
666
+ /**
667
+ * appstore (Apple App Store), googleplay (Google Play), trustpilot (a company's Trustpilot page) or googlemaps (a place's Google reviews).
668
+ */
669
+ platform?: 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
670
+ /**
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.
672
+ */
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
+ }>;
683
+ };
684
+ /**
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.
686
+ */
687
+ effect: {
688
+ /**
689
+ * Noise matches of the window (since stats.judgedSince when set) the change would have removed (estimated from the sample unless exact).
690
+ */
691
+ noiseRemoved: number;
692
+ /**
693
+ * Relevant matches of the window it would have removed.
694
+ */
695
+ relevantRemoved: number;
696
+ /**
697
+ * What the removed matches cost at the mention rate: what the change would have saved over the window.
698
+ */
699
+ centsSaved: number;
700
+ /**
701
+ * The measurement behind the estimate: the matcher's own rules run over the sampled posts.
702
+ */
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
+ };
721
+ /**
722
+ * The sample was the whole window, so the counts are measured, not estimated.
723
+ */
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: {
736
+ /**
737
+ * Keyword id (kw_...).
738
+ */
739
+ id: string;
740
+ /**
741
+ * The term as typed.
742
+ */
743
+ term: string;
744
+ group: GroupRef;
745
+ };
746
+ /**
747
+ * The window the report reads, by match time, in UTC days.
748
+ */
749
+ window: {
750
+ /**
751
+ * First day, YYYY-MM-DD, inclusive, UTC.
752
+ */
753
+ from: string;
754
+ /**
755
+ * Last day, inclusive: today.
756
+ */
757
+ to: string;
758
+ /**
759
+ * Length of the window in days.
760
+ */
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: {
775
+ /**
776
+ * Matches recorded in the window, relevant or not.
777
+ */
778
+ matches: number;
779
+ /**
780
+ * Scored at or above the relevance line (40).
781
+ */
782
+ relevant: number;
783
+ /**
784
+ * Scored under the line: the noise. Billed like any match.
785
+ */
786
+ filtered: number;
787
+ /**
788
+ * Not scored yet, or failed to score (never billed).
789
+ */
790
+ unscored: number;
791
+ /**
792
+ * filtered / (relevant + filtered); null with nothing scored.
793
+ */
794
+ noiseShare: number | null;
795
+ /**
796
+ * This keyword's share of the workspace's matches in the window; null when the workspace matched nothing.
797
+ */
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<{
807
+ /**
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).
809
+ */
810
+ platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
811
+ /**
812
+ * Matches on this platform in the window.
813
+ */
814
+ matches: number;
815
+ /**
816
+ * Of those, scored at or above the relevance line (40).
817
+ */
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
+ }>;
828
+ /**
829
+ * The trend, one row per 7 days of the window, oldest first; the last row may be shorter.
830
+ */
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
+ };
583
944
  /**
584
945
  * Workspace-wide matching rules; a rejected post is never billed.
585
946
  */
@@ -662,6 +1023,14 @@ type Mention = {
662
1023
  * Title and body, truncated to 8 KB at ingest.
663
1024
  */
664
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;
665
1034
  /**
666
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.
667
1036
  */
@@ -799,7 +1168,7 @@ type Mention = {
799
1168
  */
800
1169
  sentiment: 'positive' | 'neutral' | 'negative';
801
1170
  /**
802
- * 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).
803
1172
  */
804
1173
  intents: Array<string>;
805
1174
  /**
@@ -1152,135 +1521,599 @@ type Segment = {
1152
1521
  */
1153
1522
  updatedAt: string;
1154
1523
  };
1155
- type View = {
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
+ };
1669
+ type View = {
1670
+ /**
1671
+ * View id (vw_...).
1672
+ */
1673
+ id: string;
1674
+ name: string;
1675
+ description: string;
1676
+ filter: {
1677
+ /**
1678
+ * Substring in the post text or the author's name.
1679
+ */
1680
+ q?: string;
1681
+ /**
1682
+ * Only matches of any of these keywords.
1683
+ */
1684
+ keywordIds?: Array<string>;
1685
+ /**
1686
+ * Never matches of these keywords.
1687
+ */
1688
+ notKeywordIds?: Array<string>;
1689
+ /**
1690
+ * Only matches of keywords of any of these kinds: brand, competitor, topic.
1691
+ */
1692
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
1693
+ /**
1694
+ * Only matches of keywords in any of these groups (grp_...).
1695
+ */
1696
+ groupIds?: Array<string>;
1697
+ /**
1698
+ * Never matches of keywords in these groups.
1699
+ */
1700
+ notGroupIds?: Array<string>;
1701
+ /**
1702
+ * Only posts from any of these platforms.
1703
+ */
1704
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
1705
+ /**
1706
+ * Never posts from these platforms.
1707
+ */
1708
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
1709
+ /**
1710
+ * Only mentions in this status: open, ignored, done.
1711
+ */
1712
+ status?: 'open' | 'ignored' | 'done';
1713
+ /**
1714
+ * true: only mentions the classifier scored relevant; false: only the rest.
1715
+ */
1716
+ relevant?: boolean;
1717
+ /**
1718
+ * Only mentions scored at least this.
1719
+ */
1720
+ minRelevance?: number;
1721
+ /**
1722
+ * Only mentions whose classifier confidence is at least this.
1723
+ */
1724
+ minConfidence?: number;
1725
+ /**
1726
+ * Only these sentiments.
1727
+ */
1728
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
1729
+ /**
1730
+ * Never these sentiments; an unscored mention still passes.
1731
+ */
1732
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
1733
+ /**
1734
+ * Only mentions carrying any of these intent or topic tags.
1735
+ */
1736
+ intents?: Array<string>;
1737
+ /**
1738
+ * Never mentions carrying these tags.
1739
+ */
1740
+ notIntents?: Array<string>;
1741
+ /**
1742
+ * true: only posts that read as machine-made; false: only the rest.
1743
+ */
1744
+ automated?: boolean;
1745
+ /**
1746
+ * Only posts in any of these languages (ISO 639-1).
1747
+ */
1748
+ languages?: Array<string>;
1749
+ /**
1750
+ * Never posts in these languages; an unknown language still passes.
1751
+ */
1752
+ notLanguages?: Array<string>;
1753
+ /**
1754
+ * Only authors your workspace tagged with any of these.
1755
+ */
1756
+ tags?: Array<string>;
1757
+ /**
1758
+ * Never authors tagged with any of these.
1759
+ */
1760
+ notTags?: Array<string>;
1761
+ /**
1762
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it.
1763
+ */
1764
+ linkHosts?: Array<string>;
1765
+ /**
1766
+ * Never posts linking to these hosts.
1767
+ */
1768
+ notLinkHosts?: Array<string>;
1769
+ /**
1770
+ * Only authors with at least this many followers; unknown reach never passes.
1771
+ */
1772
+ minFollowers?: number;
1773
+ /**
1774
+ * Only authors with at most this many followers; unknown reach never passes.
1775
+ */
1776
+ maxFollowers?: number;
1777
+ /**
1778
+ * true: only replies and comments; false: only top-level posts.
1779
+ */
1780
+ isReply?: boolean;
1781
+ /**
1782
+ * Never these authors: display names, handles or profile URLs.
1783
+ */
1784
+ excludeAuthors?: Array<string>;
1785
+ /**
1786
+ * Only app store reviews with any of these star ratings; every other post fails it.
1787
+ */
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>;
1821
+ };
1822
+ /**
1823
+ * ISO 8601 timestamp, UTC.
1824
+ */
1825
+ createdAt: string;
1826
+ /**
1827
+ * ISO 8601 timestamp, UTC.
1828
+ */
1829
+ updatedAt: string;
1830
+ };
1831
+ type MentionSpikeEventData = {
1156
1832
  /**
1157
- * View id (vw_...).
1833
+ * The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
1158
1834
  */
1159
- id: string;
1160
- name: string;
1161
- description: string;
1162
- filter: {
1835
+ attentionId: string;
1836
+ /**
1837
+ * Where to look in the dashboard.
1838
+ */
1839
+ url: string;
1840
+ /**
1841
+ * The keyword the item is about.
1842
+ */
1843
+ keyword: {
1163
1844
  /**
1164
- * Substring in the post text or the author's name.
1845
+ * Keyword id (kw_...).
1165
1846
  */
1166
- q?: string;
1847
+ id: string;
1167
1848
  /**
1168
- * Only matches of any of these keywords.
1849
+ * The tracked term.
1169
1850
  */
1170
- keywordIds?: Array<string>;
1851
+ term: string;
1171
1852
  /**
1172
- * Never matches of these keywords.
1853
+ * brand, competitor or topic.
1173
1854
  */
1174
- notKeywordIds?: Array<string>;
1855
+ kind: 'brand' | 'competitor' | 'topic';
1175
1856
  /**
1176
- * Only matches of keywords of any of these kinds: brand, competitor, topic.
1857
+ * The keyword as Mentio names it: the term, or "term (Group)" outside the default group.
1177
1858
  */
1178
- keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
1859
+ name: string;
1179
1860
  /**
1180
- * Only matches of keywords in any of these groups (grp_...).
1861
+ * Its group (grp_...).
1181
1862
  */
1182
- groupIds?: Array<string>;
1863
+ groupId: string;
1864
+ };
1865
+ /**
1866
+ * The stretch of time the counts cover, by match time.
1867
+ */
1868
+ window: {
1183
1869
  /**
1184
- * Never matches of keywords in these groups.
1870
+ * Start, inclusive.
1185
1871
  */
1186
- notGroupIds?: Array<string>;
1872
+ from: string;
1187
1873
  /**
1188
- * Only posts from any of these platforms.
1874
+ * End, exclusive.
1189
1875
  */
1190
- platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
1876
+ to: string;
1877
+ };
1878
+ /**
1879
+ * Fresh matches in the hour: posts published at most 6 hours before they matched. Look-backs and free reviews never count.
1880
+ */
1881
+ matches: number;
1882
+ /**
1883
+ * Of those, scored relevant so far.
1884
+ */
1885
+ relevant: number;
1886
+ /**
1887
+ * What the keyword usually gets.
1888
+ */
1889
+ baseline: {
1191
1890
  /**
1192
- * Never posts from these platforms.
1891
+ * Fresh matches per hour over the baseline.
1193
1892
  */
1194
- notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
1893
+ meanPerHour: number;
1195
1894
  /**
1196
- * Only mentions in this status: open, ignored, done.
1895
+ * Their standard deviation.
1197
1896
  */
1198
- status?: 'open' | 'ignored' | 'done';
1897
+ stddevPerHour: number;
1199
1898
  /**
1200
- * true: only mentions the classifier scored relevant; false: only the rest.
1899
+ * Hours in the baseline: the week before the window, or since the keyword started listening.
1201
1900
  */
1202
- relevant?: boolean;
1901
+ hours: number;
1902
+ };
1903
+ };
1904
+ type NegativeSpikeEventData = {
1905
+ /**
1906
+ * The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
1907
+ */
1908
+ attentionId: string;
1909
+ /**
1910
+ * Where to look in the dashboard.
1911
+ */
1912
+ url: string;
1913
+ /**
1914
+ * The keyword the item is about.
1915
+ */
1916
+ keyword: {
1203
1917
  /**
1204
- * Only mentions scored at least this.
1918
+ * Keyword id (kw_...).
1205
1919
  */
1206
- minRelevance?: number;
1920
+ id: string;
1207
1921
  /**
1208
- * Only mentions whose classifier confidence is at least this.
1922
+ * The tracked term.
1209
1923
  */
1210
- minConfidence?: number;
1924
+ term: string;
1211
1925
  /**
1212
- * Only these sentiments.
1926
+ * brand, competitor or topic.
1213
1927
  */
1214
- sentiments?: Array<'positive' | 'neutral' | 'negative'>;
1928
+ kind: 'brand' | 'competitor' | 'topic';
1215
1929
  /**
1216
- * Never these sentiments; an unscored mention still passes.
1930
+ * The keyword as Mentio names it: the term, or "term (Group)" outside the default group.
1217
1931
  */
1218
- notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
1932
+ name: string;
1219
1933
  /**
1220
- * Only mentions carrying any of these intent or topic tags.
1934
+ * Its group (grp_...).
1221
1935
  */
1222
- intents?: Array<string>;
1936
+ groupId: string;
1937
+ };
1938
+ /**
1939
+ * The stretch of time the counts cover, by match time.
1940
+ */
1941
+ window: {
1223
1942
  /**
1224
- * Never mentions carrying these tags.
1943
+ * Start, inclusive.
1225
1944
  */
1226
- notIntents?: Array<string>;
1945
+ from: string;
1227
1946
  /**
1228
- * true: only posts that read as machine-made; false: only the rest.
1947
+ * End, exclusive.
1229
1948
  */
1230
- automated?: boolean;
1949
+ to: string;
1950
+ };
1951
+ /**
1952
+ * Relevant matches scored negative in the window.
1953
+ */
1954
+ negative: number;
1955
+ /**
1956
+ * Relevant matches in the window.
1957
+ */
1958
+ relevant: number;
1959
+ /**
1960
+ * negative / relevant.
1961
+ */
1962
+ share: number;
1963
+ /**
1964
+ * What the keyword usually reads.
1965
+ */
1966
+ baseline: {
1231
1967
  /**
1232
- * Only posts in any of these languages (ISO 639-1).
1968
+ * Negative relevant matches in the 7 days before the window.
1233
1969
  */
1234
- languages?: Array<string>;
1970
+ negative: number;
1235
1971
  /**
1236
- * Never posts in these languages; an unknown language still passes.
1972
+ * Relevant matches in those 7 days.
1237
1973
  */
1238
- notLanguages?: Array<string>;
1974
+ relevant: number;
1239
1975
  /**
1240
- * Only authors your workspace tagged with any of these.
1976
+ * The usual negative share, smoothed so a quiet week still has one.
1241
1977
  */
1242
- tags?: Array<string>;
1978
+ share: number;
1979
+ };
1980
+ };
1981
+ type KeywordNoisyEventData = {
1982
+ /**
1983
+ * The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
1984
+ */
1985
+ attentionId: string;
1986
+ /**
1987
+ * Where to look in the dashboard.
1988
+ */
1989
+ url: string;
1990
+ /**
1991
+ * The keyword the item is about.
1992
+ */
1993
+ keyword: {
1243
1994
  /**
1244
- * Never authors tagged with any of these.
1995
+ * Keyword id (kw_...).
1245
1996
  */
1246
- notTags?: Array<string>;
1997
+ id: string;
1247
1998
  /**
1248
- * Only posts linking to any of these hosts, the host itself or a subdomain of it.
1999
+ * The tracked term.
1249
2000
  */
1250
- linkHosts?: Array<string>;
2001
+ term: string;
1251
2002
  /**
1252
- * Never posts linking to these hosts.
2003
+ * brand, competitor or topic.
1253
2004
  */
1254
- notLinkHosts?: Array<string>;
2005
+ kind: 'brand' | 'competitor' | 'topic';
1255
2006
  /**
1256
- * Only authors with at least this many followers; unknown reach never passes.
2007
+ * The keyword as Mentio names it: the term, or "term (Group)" outside the default group.
1257
2008
  */
1258
- minFollowers?: number;
2009
+ name: string;
1259
2010
  /**
1260
- * Only authors with at most this many followers; unknown reach never passes.
2011
+ * Its group (grp_...).
1261
2012
  */
1262
- maxFollowers?: number;
2013
+ groupId: string;
2014
+ };
2015
+ /**
2016
+ * The window the noise is measured over, in days (since the keyword's last change when that is inside it).
2017
+ */
2018
+ windowDays: number;
2019
+ /**
2020
+ * Matches the classifier scored in that window.
2021
+ */
2022
+ scored: number;
2023
+ /**
2024
+ * Of those, relevant.
2025
+ */
2026
+ relevant: number;
2027
+ /**
2028
+ * The share scored under the relevance line. Every match bills, relevant or not.
2029
+ */
2030
+ noiseShare: number;
2031
+ };
2032
+ type ChannelFailingEventData = {
2033
+ /**
2034
+ * The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
2035
+ */
2036
+ attentionId: string;
2037
+ /**
2038
+ * Where to look in the dashboard.
2039
+ */
2040
+ url: string;
2041
+ /**
2042
+ * The channel whose sends fail.
2043
+ */
2044
+ channel: {
1263
2045
  /**
1264
- * true: only replies and comments; false: only top-level posts.
2046
+ * Channel id (dest_...).
1265
2047
  */
1266
- isReply?: boolean;
2048
+ id: string;
1267
2049
  /**
1268
- * Never these authors: display names, handles or profile URLs.
2050
+ * slack, email, webhook or telegram.
1269
2051
  */
1270
- excludeAuthors?: Array<string>;
2052
+ kind: 'slack' | 'email' | 'webhook' | 'telegram';
1271
2053
  /**
1272
- * Only app store reviews with any of these star ratings; every other post fails it.
2054
+ * The channel's label.
1273
2055
  */
1274
- ratings?: Array<number>;
2056
+ label: string;
1275
2057
  };
1276
2058
  /**
1277
- * ISO 8601 timestamp, UTC.
2059
+ * Failed sends in a row within the last 24 hours.
1278
2060
  */
1279
- createdAt: string;
2061
+ failures: number;
1280
2062
  /**
1281
- * ISO 8601 timestamp, UTC.
2063
+ * The newest failure, as the transport reported it.
1282
2064
  */
1283
- updatedAt: string;
2065
+ lastError: string | null;
2066
+ /**
2067
+ * The oldest of those failures.
2068
+ */
2069
+ since: string;
2070
+ };
2071
+ type AttentionItem = {
2072
+ /**
2073
+ * Attention item id (att_...).
2074
+ */
2075
+ id: string;
2076
+ /**
2077
+ * mention.spike: far more mentions in the last hour than the keyword usually gets. sentiment.negative_spike: the negative share of the last 24 hours jumped. keyword.noisy: most scored matches are noise. channel.failing: the channel's last sends all failed.
2078
+ */
2079
+ kind: 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing';
2080
+ /**
2081
+ * open: the condition holds. resolved: it no longer does. dismissed: a person put it away; it does not come back for the same episode.
2082
+ */
2083
+ status: 'open' | 'resolved' | 'dismissed';
2084
+ /**
2085
+ * What the item is about.
2086
+ */
2087
+ subject: {
2088
+ /**
2089
+ * keyword or channel.
2090
+ */
2091
+ type: 'keyword' | 'channel';
2092
+ /**
2093
+ * The keyword (kw_...) or the channel (dest_...).
2094
+ */
2095
+ id: string;
2096
+ };
2097
+ /**
2098
+ * One line for a person: what happened.
2099
+ */
2100
+ title: string;
2101
+ /**
2102
+ * When the condition was first seen.
2103
+ */
2104
+ openedAt: string;
2105
+ /**
2106
+ * When it no longer held; null while it does.
2107
+ */
2108
+ resolvedAt: string | null;
2109
+ /**
2110
+ * When a person dismissed it; null if nobody did.
2111
+ */
2112
+ dismissedAt: string | null;
2113
+ /**
2114
+ * The facts as they stood when it opened: the same object the account event of the same name carries as `data`.
2115
+ */
2116
+ data: MentionSpikeEventData | NegativeSpikeEventData | KeywordNoisyEventData | ChannelFailingEventData;
1284
2117
  };
1285
2118
  /**
1286
2119
  * The group the keyword belongs to.
@@ -1889,9 +2722,9 @@ type Alert = {
1889
2722
  name: string;
1890
2723
  enabled: boolean;
1891
2724
  /**
1892
- * instant: each matching mention as it happens. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
2725
+ * instant: each matching mention as it happens. hourly: one digest each UTC hour (five minutes past, so the last mentions of the hour are scored) covering the previous full hour, nothing when that hour has no mention at or over the rule's relevance floor; Slack, Telegram and webhook channels only. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
1893
2726
  */
1894
- mode: 'instant' | 'daily' | 'weekly';
2727
+ mode: 'instant' | 'hourly' | 'daily' | 'weekly';
1895
2728
  filter: {
1896
2729
  /**
1897
2730
  * Only these keywords.
@@ -1949,9 +2782,41 @@ type Alert = {
1949
2782
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
1950
2783
  */
1951
2784
  ratings?: Array<number>;
2785
+ /**
2786
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
2787
+ */
2788
+ notRatings?: Array<number>;
2789
+ /**
2790
+ * 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.
2791
+ */
2792
+ minLikes?: number;
2793
+ /**
2794
+ * 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.
2795
+ */
2796
+ minReposts?: number;
2797
+ /**
2798
+ * 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.
2799
+ */
2800
+ minReplies?: number;
2801
+ /**
2802
+ * 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.
2803
+ */
2804
+ minQuotes?: number;
2805
+ /**
2806
+ * 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.
2807
+ */
2808
+ minViews?: number;
2809
+ /**
2810
+ * 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.
2811
+ */
2812
+ minBookmarks?: number;
2813
+ /**
2814
+ * 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.
2815
+ */
2816
+ anyOf?: Array<FilterGroup>;
1952
2817
  };
1953
2818
  /**
1954
- * Daily and weekly alerts only.
2819
+ * Daily and weekly alerts only; null for instant and hourly ones.
1955
2820
  */
1956
2821
  schedule: {
1957
2822
  hour: number;
@@ -1988,7 +2853,7 @@ type Alert = {
1988
2853
  */
1989
2854
  lastSentAt: string | null;
1990
2855
  /**
1991
- * Daily and weekly alerts: the next digest; null when disabled or instant.
2856
+ * Hourly, daily and weekly alerts: the next digest; null when disabled or instant.
1992
2857
  */
1993
2858
  nextRunAt: string | null;
1994
2859
  };
@@ -2779,6 +3644,10 @@ type SlackChannel = {
2779
3644
  * Slack channel name, without the #.
2780
3645
  */
2781
3646
  channelName: string;
3647
+ /**
3648
+ * The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
3649
+ */
3650
+ events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
2782
3651
  };
2783
3652
  };
2784
3653
  type EmailChannel = {
@@ -2827,6 +3696,10 @@ type EmailChannel = {
2827
3696
  */
2828
3697
  confirmedAt: string | null;
2829
3698
  }>;
3699
+ /**
3700
+ * The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
3701
+ */
3702
+ events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
2830
3703
  };
2831
3704
  };
2832
3705
  type WebhookChannel = {
@@ -2876,9 +3749,9 @@ type WebhookChannel = {
2876
3749
  [key: string]: string;
2877
3750
  };
2878
3751
  /**
2879
- * The account events this endpoint receives on its own, no rule involved: keyword and wallet state changes. Empty when it receives none; mention and digest deliveries come through rules as before.
3752
+ * The account events this endpoint receives on its own, no rule involved: keyword and wallet state changes and the attention events. Empty when it receives none; mention and digest deliveries come through rules as before.
2880
3753
  */
2881
- events: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed'>;
3754
+ events: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
2882
3755
  /**
2883
3756
  * Only on creation and rotation. Signs every request: X-Mentions-Signature-V2 is v2= plus the hex HMAC-SHA256 of "<X-Mentions-Timestamp>.<raw body>" (reject a timestamp older than a few minutes); X-Mentions-Signature, the hex HMAC-SHA256 of the raw body alone, stays for older verifiers.
2884
3757
  */
@@ -2926,6 +3799,10 @@ type TelegramChannel = {
2926
3799
  */
2927
3800
  chatId: string;
2928
3801
  chatType: 'private' | 'group' | 'supergroup' | 'channel';
3802
+ /**
3803
+ * The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
3804
+ */
3805
+ events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
2929
3806
  };
2930
3807
  };
2931
3808
  type Channel = ({
@@ -2947,6 +3824,10 @@ type CreateSlackChannel = {
2947
3824
  * The channel name, for the label.
2948
3825
  */
2949
3826
  channelName: string;
3827
+ /**
3828
+ * Attention events to receive here, on top of whatever rules send. Omit for none.
3829
+ */
3830
+ events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
2950
3831
  };
2951
3832
  type CreateEmailChannel = {
2952
3833
  kind: 'email';
@@ -2954,6 +3835,10 @@ type CreateEmailChannel = {
2954
3835
  * Each address gets a confirmation link; workspace members are confirmed on sight.
2955
3836
  */
2956
3837
  emails: Array<string>;
3838
+ /**
3839
+ * Attention events to receive here, on top of whatever rules send. Omit for none.
3840
+ */
3841
+ events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
2957
3842
  };
2958
3843
  type CreateWebhookChannel = {
2959
3844
  kind: 'webhook';
@@ -2972,9 +3857,9 @@ type CreateWebhookChannel = {
2972
3857
  [key: string]: string;
2973
3858
  };
2974
3859
  /**
2975
- * Account events to receive at this endpoint (keyword and wallet state changes), on top of whatever rules send here. Omit for none.
3860
+ * Account events to receive at this endpoint (keyword and wallet state changes, attention events), on top of whatever rules send here. Omit for none.
2976
3861
  */
2977
- events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed'>;
3862
+ events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
2978
3863
  };
2979
3864
  type GetHealthData = {
2980
3865
  body?: never;
@@ -3178,6 +4063,10 @@ type ListKeywordsResponses = {
3178
4063
  */
3179
4064
  noisy: boolean;
3180
4065
  };
4066
+ /**
4067
+ * 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.
4068
+ */
4069
+ health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
3181
4070
  /**
3182
4071
  * 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.
3183
4072
  */
@@ -3507,14 +4396,60 @@ type UpdateKeywordErrors = {
3507
4396
  */
3508
4397
  404: ErrorResponse;
3509
4398
  };
3510
- type UpdateKeywordError = UpdateKeywordErrors[keyof UpdateKeywordErrors];
3511
- type UpdateKeywordResponses = {
4399
+ type UpdateKeywordError = UpdateKeywordErrors[keyof UpdateKeywordErrors];
4400
+ type UpdateKeywordResponses = {
4401
+ /**
4402
+ * The updated keyword
4403
+ */
4404
+ 200: Keyword;
4405
+ };
4406
+ type UpdateKeywordResponse = UpdateKeywordResponses[keyof UpdateKeywordResponses];
4407
+ type GetKeywordHealthData = {
4408
+ body?: never;
4409
+ path: {
4410
+ /**
4411
+ * Keyword id (kw_...).
4412
+ */
4413
+ id: string;
4414
+ };
4415
+ query?: {
4416
+ /**
4417
+ * Trailing window of UTC days ending today, by match time: 7d, 30d, 90d (default 30d).
4418
+ */
4419
+ range?: '7d' | '30d' | '90d';
4420
+ /**
4421
+ * 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.
4422
+ */
4423
+ ai?: boolean;
4424
+ };
4425
+ url: '/v1/keywords/{id}/health';
4426
+ };
4427
+ type GetKeywordHealthErrors = {
4428
+ /**
4429
+ * Invalid query parameters
4430
+ */
4431
+ 400: ErrorResponse;
4432
+ /**
4433
+ * Missing or invalid API key
4434
+ */
4435
+ 401: ErrorResponse;
4436
+ /**
4437
+ * Keyword not found
4438
+ */
4439
+ 404: ErrorResponse;
4440
+ /**
4441
+ * More than 30 health reads this minute (rate_limited)
4442
+ */
4443
+ 429: ErrorResponse;
4444
+ };
4445
+ type GetKeywordHealthError = GetKeywordHealthErrors[keyof GetKeywordHealthErrors];
4446
+ type GetKeywordHealthResponses = {
3512
4447
  /**
3513
- * The updated keyword
4448
+ * The keyword's health report
3514
4449
  */
3515
- 200: Keyword;
4450
+ 200: KeywordHealth;
3516
4451
  };
3517
- type UpdateKeywordResponse = UpdateKeywordResponses[keyof UpdateKeywordResponses];
4452
+ type GetKeywordHealthResponse = GetKeywordHealthResponses[keyof GetKeywordHealthResponses];
3518
4453
  type GetFiltersData = {
3519
4454
  body?: never;
3520
4455
  path?: never;
@@ -3707,7 +4642,242 @@ type SearchMentionsData = {
3707
4642
  */
3708
4643
  sentiment?: 'positive' | 'neutral' | 'negative';
3709
4644
  /**
3710
- * Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
4645
+ * 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).
4646
+ */
4647
+ intent?: string;
4648
+ /**
4649
+ * 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.
4650
+ */
4651
+ automated?: boolean;
4652
+ /**
4653
+ * Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
4654
+ */
4655
+ personId?: string;
4656
+ /**
4657
+ * true: include mentions by people you muted, hidden by default.
4658
+ */
4659
+ includeMuted?: boolean;
4660
+ /**
4661
+ * Only mentions assigned to this workspace member (user id).
4662
+ */
4663
+ assigneeId?: string;
4664
+ /**
4665
+ * true: only mentions currently snoozed. Otherwise snoozed mentions stay out until they wake.
4666
+ */
4667
+ snoozed?: boolean;
4668
+ /**
4669
+ * Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
4670
+ */
4671
+ excludeAuthors?: Array<string> | null;
4672
+ /**
4673
+ * Only mentions scored at least this; unclassified ones are excluded.
4674
+ */
4675
+ minRelevance?: number | null;
4676
+ /**
4677
+ * Only mentions whose classifier confidence is at least this, 0 to 1. Mentions without a confidence are excluded.
4678
+ */
4679
+ minConfidence?: number | null;
4680
+ /**
4681
+ * Only authors with at least this many followers. Unknown reach never passes.
4682
+ */
4683
+ minFollowers?: number | null;
4684
+ /**
4685
+ * Only authors with at most this many followers. Unknown reach never passes.
4686
+ */
4687
+ maxFollowers?: number | null;
4688
+ /**
4689
+ * true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
4690
+ */
4691
+ isReply?: boolean;
4692
+ /**
4693
+ * 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.
4694
+ */
4695
+ alertId?: string;
4696
+ /**
4697
+ * 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.
4698
+ */
4699
+ viewId?: string;
4700
+ /**
4701
+ * Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
4702
+ */
4703
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
4704
+ /**
4705
+ * Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
4706
+ */
4707
+ tags?: Array<string> | null;
4708
+ /**
4709
+ * 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.
4710
+ */
4711
+ linkHosts?: Array<string> | null;
4712
+ /**
4713
+ * Only posts from any of these platforms.
4714
+ */
4715
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
4716
+ /**
4717
+ * Never posts from these platforms.
4718
+ */
4719
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
4720
+ /**
4721
+ * Only matches of any of these keywords.
4722
+ */
4723
+ keywordIds?: Array<string> | null;
4724
+ /**
4725
+ * Only matches of keywords in any of these groups (grp_...). Repeatable, or comma-separated.
4726
+ */
4727
+ groupIds?: Array<string> | null;
4728
+ /**
4729
+ * Never matches of keywords in these groups.
4730
+ */
4731
+ notGroupIds?: Array<string> | null;
4732
+ /**
4733
+ * Never matches of these keywords.
4734
+ */
4735
+ notKeywordIds?: Array<string> | null;
4736
+ /**
4737
+ * Only these sentiments.
4738
+ */
4739
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
4740
+ /**
4741
+ * Never these sentiments. A mention the classifier has not scored yet still passes.
4742
+ */
4743
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
4744
+ /**
4745
+ * Only mentions carrying any of these intent or topic tags.
4746
+ */
4747
+ intents?: Array<string> | null;
4748
+ /**
4749
+ * Never mentions carrying these intent or topic tags.
4750
+ */
4751
+ notIntents?: Array<string> | null;
4752
+ /**
4753
+ * Never posts linking to these hosts, the host itself or a subdomain of it.
4754
+ */
4755
+ notLinkHosts?: Array<string> | null;
4756
+ /**
4757
+ * Never authors your workspace tagged with any of these.
4758
+ */
4759
+ notTags?: Array<string> | null;
4760
+ /**
4761
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
4762
+ */
4763
+ languages?: Array<string>;
4764
+ /**
4765
+ * Never posts in these languages. A post whose language is unknown still passes.
4766
+ */
4767
+ notLanguages?: Array<string>;
4768
+ /**
4769
+ * 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.
4770
+ */
4771
+ ratings?: Array<number>;
4772
+ /**
4773
+ * Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
4774
+ */
4775
+ notRatings?: Array<number>;
4776
+ /**
4777
+ * 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.
4778
+ */
4779
+ minLikes?: number | null;
4780
+ /**
4781
+ * 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.
4782
+ */
4783
+ minReposts?: number | null;
4784
+ /**
4785
+ * 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.
4786
+ */
4787
+ minReplies?: number | null;
4788
+ /**
4789
+ * 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.
4790
+ */
4791
+ minQuotes?: number | null;
4792
+ /**
4793
+ * 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.
4794
+ */
4795
+ minViews?: number | null;
4796
+ /**
4797
+ * 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.
4798
+ */
4799
+ minBookmarks?: number | null;
4800
+ /**
4801
+ * 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.
4802
+ */
4803
+ anyOf?: string;
4804
+ /**
4805
+ * Substring search in the post text or the author's name.
4806
+ */
4807
+ q?: string;
4808
+ /**
4809
+ * Only posts published at or after this instant (ISO 8601, or epoch ms).
4810
+ */
4811
+ since?: string;
4812
+ /**
4813
+ * Only posts published at or before this instant (ISO 8601, or epoch ms).
4814
+ */
4815
+ until?: string;
4816
+ /**
4817
+ * 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.
4818
+ */
4819
+ sort?: 'newest' | 'priority';
4820
+ /**
4821
+ * nextCursor from the previous page; pass the same filters and sort.
4822
+ */
4823
+ cursor?: string;
4824
+ /**
4825
+ * Page size, 1 to 100.
4826
+ */
4827
+ limit?: number;
4828
+ };
4829
+ url: '/v1/mentions';
4830
+ };
4831
+ type SearchMentionsErrors = {
4832
+ /**
4833
+ * 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
4834
+ */
4835
+ 400: ErrorResponse;
4836
+ /**
4837
+ * Missing or invalid API key
4838
+ */
4839
+ 401: ErrorResponse;
4840
+ };
4841
+ type SearchMentionsError = SearchMentionsErrors[keyof SearchMentionsErrors];
4842
+ type SearchMentionsResponses = {
4843
+ /**
4844
+ * One page of mentions in the requested order
4845
+ */
4846
+ 200: {
4847
+ data: Array<Mention>;
4848
+ /**
4849
+ * Pass as cursor for the next page; null on the last page.
4850
+ */
4851
+ nextCursor: string | null;
4852
+ };
4853
+ };
4854
+ type SearchMentionsResponse = SearchMentionsResponses[keyof SearchMentionsResponses];
4855
+ type ExportMentionsCsvData = {
4856
+ body?: never;
4857
+ path?: never;
4858
+ query?: {
4859
+ /**
4860
+ * Only matches of this keyword.
4861
+ */
4862
+ keywordId?: string;
4863
+ /**
4864
+ * Only posts from this platform.
4865
+ */
4866
+ platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
4867
+ /**
4868
+ * Only mentions in this status. Omit for every status.
4869
+ */
4870
+ status?: 'open' | 'ignored' | 'done';
4871
+ /**
4872
+ * true: only mentions the classifier scored relevant; false: only the rest (unclassified included).
4873
+ */
4874
+ relevant?: boolean;
4875
+ /**
4876
+ * Only this sentiment.
4877
+ */
4878
+ sentiment?: 'positive' | 'neutral' | 'negative';
4879
+ /**
4880
+ * 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).
3711
4881
  */
3712
4882
  intent?: string;
3713
4883
  /**
@@ -3805,35 +4975,67 @@ type SearchMentionsData = {
3805
4975
  /**
3806
4976
  * Never these sentiments. A mention the classifier has not scored yet still passes.
3807
4977
  */
3808
- notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
4978
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
4979
+ /**
4980
+ * Only mentions carrying any of these intent or topic tags.
4981
+ */
4982
+ intents?: Array<string> | null;
4983
+ /**
4984
+ * Never mentions carrying these intent or topic tags.
4985
+ */
4986
+ notIntents?: Array<string> | null;
4987
+ /**
4988
+ * Never posts linking to these hosts, the host itself or a subdomain of it.
4989
+ */
4990
+ notLinkHosts?: Array<string> | null;
4991
+ /**
4992
+ * Never authors your workspace tagged with any of these.
4993
+ */
4994
+ notTags?: Array<string> | null;
4995
+ /**
4996
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
4997
+ */
4998
+ languages?: Array<string>;
4999
+ /**
5000
+ * Never posts in these languages. A post whose language is unknown still passes.
5001
+ */
5002
+ notLanguages?: Array<string>;
5003
+ /**
5004
+ * 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.
5005
+ */
5006
+ ratings?: Array<number>;
5007
+ /**
5008
+ * Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
5009
+ */
5010
+ notRatings?: Array<number>;
3809
5011
  /**
3810
- * Only mentions carrying any of these intent or topic tags.
5012
+ * 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.
3811
5013
  */
3812
- intents?: Array<string> | null;
5014
+ minLikes?: number | null;
3813
5015
  /**
3814
- * Never mentions carrying these intent or topic tags.
5016
+ * 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.
3815
5017
  */
3816
- notIntents?: Array<string> | null;
5018
+ minReposts?: number | null;
3817
5019
  /**
3818
- * Never posts linking to these hosts, the host itself or a subdomain of it.
5020
+ * 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.
3819
5021
  */
3820
- notLinkHosts?: Array<string> | null;
5022
+ minReplies?: number | null;
3821
5023
  /**
3822
- * Never authors your workspace tagged with any of these.
5024
+ * 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.
3823
5025
  */
3824
- notTags?: Array<string> | null;
5026
+ minQuotes?: number | null;
3825
5027
  /**
3826
- * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
5028
+ * 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.
3827
5029
  */
3828
- languages?: Array<string>;
5030
+ minViews?: number | null;
3829
5031
  /**
3830
- * Never posts in these languages. A post whose language is unknown still passes.
5032
+ * 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.
3831
5033
  */
3832
- notLanguages?: Array<string>;
5034
+ minBookmarks?: number | null;
3833
5035
  /**
3834
- * 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.
5036
+ * 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.
3835
5037
  */
3836
- ratings?: Array<number>;
5038
+ anyOf?: string;
3837
5039
  /**
3838
5040
  * Substring search in the post text or the author's name.
3839
5041
  */
@@ -3846,46 +5048,32 @@ type SearchMentionsData = {
3846
5048
  * Only posts published at or before this instant (ISO 8601, or epoch ms).
3847
5049
  */
3848
5050
  until?: string;
3849
- /**
3850
- * 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.
3851
- */
3852
- sort?: 'newest' | 'priority';
3853
- /**
3854
- * nextCursor from the previous page; pass the same filters and sort.
3855
- */
3856
- cursor?: string;
3857
- /**
3858
- * Page size, 1 to 100.
3859
- */
3860
- limit?: number;
3861
5051
  };
3862
- url: '/v1/mentions';
5052
+ url: '/v1/mentions/export.csv';
3863
5053
  };
3864
- type SearchMentionsErrors = {
5054
+ type ExportMentionsCsvErrors = {
3865
5055
  /**
3866
- * Invalid query or pagination cursor
5056
+ * Invalid query, or filter_too_complex: the filters together name more values than one query can carry
3867
5057
  */
3868
5058
  400: ErrorResponse;
3869
5059
  /**
3870
5060
  * Missing or invalid API key
3871
5061
  */
3872
5062
  401: ErrorResponse;
5063
+ /**
5064
+ * More than 6 exports this minute; retry after the Retry-After seconds
5065
+ */
5066
+ 429: ErrorResponse;
3873
5067
  };
3874
- type SearchMentionsError = SearchMentionsErrors[keyof SearchMentionsErrors];
3875
- type SearchMentionsResponses = {
5068
+ type ExportMentionsCsvError = ExportMentionsCsvErrors[keyof ExportMentionsCsvErrors];
5069
+ type ExportMentionsCsvResponses = {
3876
5070
  /**
3877
- * One page of mentions in the requested order
5071
+ * CSV, UTF-8
3878
5072
  */
3879
- 200: {
3880
- data: Array<Mention>;
3881
- /**
3882
- * Pass as cursor for the next page; null on the last page.
3883
- */
3884
- nextCursor: string | null;
3885
- };
5073
+ 200: string;
3886
5074
  };
3887
- type SearchMentionsResponse = SearchMentionsResponses[keyof SearchMentionsResponses];
3888
- type ExportMentionsCsvData = {
5075
+ type ExportMentionsCsvResponse = ExportMentionsCsvResponses[keyof ExportMentionsCsvResponses];
5076
+ type ExportMentionsJsonData = {
3889
5077
  body?: never;
3890
5078
  path?: never;
3891
5079
  query?: {
@@ -3910,7 +5098,7 @@ type ExportMentionsCsvData = {
3910
5098
  */
3911
5099
  sentiment?: 'positive' | 'neutral' | 'negative';
3912
5100
  /**
3913
- * Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
5101
+ * 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).
3914
5102
  */
3915
5103
  intent?: string;
3916
5104
  /**
@@ -4037,6 +5225,38 @@ type ExportMentionsCsvData = {
4037
5225
  * 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.
4038
5226
  */
4039
5227
  ratings?: Array<number>;
5228
+ /**
5229
+ * Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
5230
+ */
5231
+ notRatings?: Array<number>;
5232
+ /**
5233
+ * 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.
5234
+ */
5235
+ minLikes?: number | null;
5236
+ /**
5237
+ * 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.
5238
+ */
5239
+ minReposts?: number | null;
5240
+ /**
5241
+ * 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.
5242
+ */
5243
+ minReplies?: number | null;
5244
+ /**
5245
+ * 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.
5246
+ */
5247
+ minQuotes?: number | null;
5248
+ /**
5249
+ * 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.
5250
+ */
5251
+ minViews?: number | null;
5252
+ /**
5253
+ * 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.
5254
+ */
5255
+ minBookmarks?: number | null;
5256
+ /**
5257
+ * 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.
5258
+ */
5259
+ anyOf?: string;
4040
5260
  /**
4041
5261
  * Substring search in the post text or the author's name.
4042
5262
  */
@@ -4050,11 +5270,11 @@ type ExportMentionsCsvData = {
4050
5270
  */
4051
5271
  until?: string;
4052
5272
  };
4053
- url: '/v1/mentions/export.csv';
5273
+ url: '/v1/mentions/export.json';
4054
5274
  };
4055
- type ExportMentionsCsvErrors = {
5275
+ type ExportMentionsJsonErrors = {
4056
5276
  /**
4057
- * Invalid query
5277
+ * Invalid query, or filter_too_complex: the filters together name more values than one query can carry
4058
5278
  */
4059
5279
  400: ErrorResponse;
4060
5280
  /**
@@ -4066,14 +5286,23 @@ type ExportMentionsCsvErrors = {
4066
5286
  */
4067
5287
  429: ErrorResponse;
4068
5288
  };
4069
- type ExportMentionsCsvError = ExportMentionsCsvErrors[keyof ExportMentionsCsvErrors];
4070
- type ExportMentionsCsvResponses = {
5289
+ type ExportMentionsJsonError = ExportMentionsJsonErrors[keyof ExportMentionsJsonErrors];
5290
+ type ExportMentionsJsonResponses = {
4071
5291
  /**
4072
- * CSV, UTF-8
5292
+ * Every matching mention, up to the cap
4073
5293
  */
4074
- 200: string;
5294
+ 200: {
5295
+ /**
5296
+ * At most 10,000 mentions, newest matched first.
5297
+ */
5298
+ data: Array<Mention>;
5299
+ /**
5300
+ * true when more mentions matched than the cap returns: narrow the filters (since, until) and export again.
5301
+ */
5302
+ truncated: boolean;
5303
+ };
4075
5304
  };
4076
- type ExportMentionsCsvResponse = ExportMentionsCsvResponses[keyof ExportMentionsCsvResponses];
5305
+ type ExportMentionsJsonResponse = ExportMentionsJsonResponses[keyof ExportMentionsJsonResponses];
4077
5306
  type ExportPeopleCsvData = {
4078
5307
  body?: never;
4079
5308
  path?: never;
@@ -4086,6 +5315,10 @@ type ExportPeopleCsvData = {
4086
5315
  * Matches the display name or the profile handle or URL, case-insensitively.
4087
5316
  */
4088
5317
  q?: string;
5318
+ /**
5319
+ * 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.
5320
+ */
5321
+ handle?: string;
4089
5322
  /**
4090
5323
  * Only people carrying this tag (exact, case-sensitive).
4091
5324
  */
@@ -4215,6 +5448,10 @@ type ListPeopleData = {
4215
5448
  * Matches the display name or the profile handle or URL, case-insensitively.
4216
5449
  */
4217
5450
  q?: string;
5451
+ /**
5452
+ * 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.
5453
+ */
5454
+ handle?: string;
4218
5455
  /**
4219
5456
  * Only people carrying this tag (exact, case-sensitive).
4220
5457
  */
@@ -5395,6 +6632,38 @@ type ListViewsResponses = {
5395
6632
  * Only app store reviews with any of these star ratings; every other post fails it.
5396
6633
  */
5397
6634
  ratings?: Array<number>;
6635
+ /**
6636
+ * Never reviews with these star ratings; posts that are not reviews still pass.
6637
+ */
6638
+ notRatings?: Array<number>;
6639
+ /**
6640
+ * 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.
6641
+ */
6642
+ minLikes?: number;
6643
+ /**
6644
+ * 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.
6645
+ */
6646
+ minReposts?: number;
6647
+ /**
6648
+ * 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.
6649
+ */
6650
+ minReplies?: number;
6651
+ /**
6652
+ * 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.
6653
+ */
6654
+ minQuotes?: number;
6655
+ /**
6656
+ * 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.
6657
+ */
6658
+ minViews?: number;
6659
+ /**
6660
+ * 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.
6661
+ */
6662
+ minBookmarks?: number;
6663
+ /**
6664
+ * 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.
6665
+ */
6666
+ anyOf?: Array<FilterGroup>;
5398
6667
  };
5399
6668
  /**
5400
6669
  * ISO 8601 timestamp, UTC.
@@ -5534,6 +6803,38 @@ type CreateViewData = {
5534
6803
  * Only app store reviews with any of these star ratings; every other post fails it.
5535
6804
  */
5536
6805
  ratings?: Array<number>;
6806
+ /**
6807
+ * Never reviews with these star ratings; posts that are not reviews still pass.
6808
+ */
6809
+ notRatings?: Array<number>;
6810
+ /**
6811
+ * 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.
6812
+ */
6813
+ minLikes?: number;
6814
+ /**
6815
+ * 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.
6816
+ */
6817
+ minReposts?: number;
6818
+ /**
6819
+ * 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.
6820
+ */
6821
+ minReplies?: number;
6822
+ /**
6823
+ * 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.
6824
+ */
6825
+ minQuotes?: number;
6826
+ /**
6827
+ * 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.
6828
+ */
6829
+ minViews?: number;
6830
+ /**
6831
+ * 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.
6832
+ */
6833
+ minBookmarks?: number;
6834
+ /**
6835
+ * 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.
6836
+ */
6837
+ anyOf?: Array<FilterGroup>;
5537
6838
  };
5538
6839
  };
5539
6840
  path?: never;
@@ -5541,6 +6842,10 @@ type CreateViewData = {
5541
6842
  url: '/v1/views';
5542
6843
  };
5543
6844
  type CreateViewErrors = {
6845
+ /**
6846
+ * Invalid filter (an empty anyOf group, for one), or filter_too_complex: more values than one query can carry
6847
+ */
6848
+ 400: ErrorResponse;
5544
6849
  /**
5545
6850
  * Missing or invalid API key
5546
6851
  */
@@ -5736,6 +7041,38 @@ type UpdateViewData = {
5736
7041
  * Only app store reviews with any of these star ratings; every other post fails it.
5737
7042
  */
5738
7043
  ratings?: Array<number>;
7044
+ /**
7045
+ * Never reviews with these star ratings; posts that are not reviews still pass.
7046
+ */
7047
+ notRatings?: Array<number>;
7048
+ /**
7049
+ * 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.
7050
+ */
7051
+ minLikes?: number;
7052
+ /**
7053
+ * 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.
7054
+ */
7055
+ minReposts?: number;
7056
+ /**
7057
+ * 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.
7058
+ */
7059
+ minReplies?: number;
7060
+ /**
7061
+ * 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.
7062
+ */
7063
+ minQuotes?: number;
7064
+ /**
7065
+ * 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.
7066
+ */
7067
+ minViews?: number;
7068
+ /**
7069
+ * 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.
7070
+ */
7071
+ minBookmarks?: number;
7072
+ /**
7073
+ * 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.
7074
+ */
7075
+ anyOf?: Array<FilterGroup>;
5739
7076
  };
5740
7077
  };
5741
7078
  path: {
@@ -5769,6 +7106,82 @@ type UpdateViewResponses = {
5769
7106
  200: View;
5770
7107
  };
5771
7108
  type UpdateViewResponse = UpdateViewResponses[keyof UpdateViewResponses];
7109
+ type ListAttentionData = {
7110
+ body?: never;
7111
+ path?: never;
7112
+ query?: {
7113
+ /**
7114
+ * open (default), resolved, dismissed, or all.
7115
+ */
7116
+ status?: 'open' | 'resolved' | 'dismissed' | 'all';
7117
+ /**
7118
+ * Only these kinds, comma separated: mention.spike, sentiment.negative_spike, keyword.noisy, channel.failing.
7119
+ */
7120
+ kind?: string;
7121
+ /**
7122
+ * Items per page, newest first; 50 by default, at most 100.
7123
+ */
7124
+ limit?: number;
7125
+ /**
7126
+ * nextCursor from the previous page.
7127
+ */
7128
+ cursor?: string;
7129
+ };
7130
+ url: '/v1/attention';
7131
+ };
7132
+ type ListAttentionErrors = {
7133
+ /**
7134
+ * Unknown kind, or a cursor this list did not hand out
7135
+ */
7136
+ 400: ErrorResponse;
7137
+ /**
7138
+ * Missing or invalid API key
7139
+ */
7140
+ 401: ErrorResponse;
7141
+ };
7142
+ type ListAttentionError = ListAttentionErrors[keyof ListAttentionErrors];
7143
+ type ListAttentionResponses = {
7144
+ /**
7145
+ * Attention items
7146
+ */
7147
+ 200: {
7148
+ data: Array<AttentionItem>;
7149
+ /**
7150
+ * Pass as cursor for the next page; null on the last one.
7151
+ */
7152
+ nextCursor: string | null;
7153
+ };
7154
+ };
7155
+ type ListAttentionResponse = ListAttentionResponses[keyof ListAttentionResponses];
7156
+ type DismissAttentionData = {
7157
+ body?: never;
7158
+ path: {
7159
+ /**
7160
+ * Attention item id (att_...).
7161
+ */
7162
+ id: string;
7163
+ };
7164
+ query?: never;
7165
+ url: '/v1/attention/{id}/dismiss';
7166
+ };
7167
+ type DismissAttentionErrors = {
7168
+ /**
7169
+ * Missing or invalid API key
7170
+ */
7171
+ 401: ErrorResponse;
7172
+ /**
7173
+ * No such attention item in this workspace
7174
+ */
7175
+ 404: ErrorResponse;
7176
+ };
7177
+ type DismissAttentionError = DismissAttentionErrors[keyof DismissAttentionErrors];
7178
+ type DismissAttentionResponses = {
7179
+ /**
7180
+ * The dismissed item
7181
+ */
7182
+ 200: AttentionItem;
7183
+ };
7184
+ type DismissAttentionResponse = DismissAttentionResponses[keyof DismissAttentionResponses];
5772
7185
  type ListGroupsData = {
5773
7186
  body?: never;
5774
7187
  path?: never;
@@ -6669,7 +8082,7 @@ type UpdateAlertData = {
6669
8082
  body: {
6670
8083
  name?: string;
6671
8084
  enabled?: boolean;
6672
- mode?: 'instant' | 'daily' | 'weekly';
8085
+ mode?: 'instant' | 'hourly' | 'daily' | 'weekly';
6673
8086
  /**
6674
8087
  * Replaces the whole filter.
6675
8088
  */
@@ -6730,7 +8143,42 @@ type UpdateAlertData = {
6730
8143
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
6731
8144
  */
6732
8145
  ratings?: Array<number>;
8146
+ /**
8147
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
8148
+ */
8149
+ notRatings?: Array<number>;
8150
+ /**
8151
+ * 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.
8152
+ */
8153
+ minLikes?: number;
8154
+ /**
8155
+ * 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.
8156
+ */
8157
+ minReposts?: number;
8158
+ /**
8159
+ * 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.
8160
+ */
8161
+ minReplies?: number;
8162
+ /**
8163
+ * 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.
8164
+ */
8165
+ minQuotes?: number;
8166
+ /**
8167
+ * 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.
8168
+ */
8169
+ minViews?: number;
8170
+ /**
8171
+ * 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.
8172
+ */
8173
+ minBookmarks?: number;
8174
+ /**
8175
+ * 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.
8176
+ */
8177
+ anyOf?: Array<FilterGroup>;
6733
8178
  };
8179
+ /**
8180
+ * Daily and weekly alerts. Ignored on an hourly one, except a weekday, which is refused.
8181
+ */
6734
8182
  schedule?: {
6735
8183
  hour: number;
6736
8184
  minute?: number;
@@ -6758,7 +8206,7 @@ type UpdateAlertData = {
6758
8206
  };
6759
8207
  type UpdateAlertErrors = {
6760
8208
  /**
6761
- * A daily or weekly rule without a schedule (or a weekly one without a weekday), or an unknown channel
8209
+ * A daily or weekly rule without a schedule (or a weekly one without a weekday), an hourly one with a weekday or an email channel (hourly_email_unsupported), or an unknown channel
6762
8210
  */
6763
8211
  400: ErrorResponse;
6764
8212
  /**
@@ -6804,9 +8252,9 @@ type ListAlertsResponses = {
6804
8252
  name: string;
6805
8253
  enabled: boolean;
6806
8254
  /**
6807
- * instant: each matching mention as it happens. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
8255
+ * instant: each matching mention as it happens. hourly: one digest each UTC hour (five minutes past, so the last mentions of the hour are scored) covering the previous full hour, nothing when that hour has no mention at or over the rule's relevance floor; Slack, Telegram and webhook channels only. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
6808
8256
  */
6809
- mode: 'instant' | 'daily' | 'weekly';
8257
+ mode: 'instant' | 'hourly' | 'daily' | 'weekly';
6810
8258
  filter: {
6811
8259
  /**
6812
8260
  * Only these keywords.
@@ -6864,9 +8312,41 @@ type ListAlertsResponses = {
6864
8312
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
6865
8313
  */
6866
8314
  ratings?: Array<number>;
8315
+ /**
8316
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
8317
+ */
8318
+ notRatings?: Array<number>;
8319
+ /**
8320
+ * 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.
8321
+ */
8322
+ minLikes?: number;
8323
+ /**
8324
+ * 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.
8325
+ */
8326
+ minReposts?: number;
8327
+ /**
8328
+ * 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.
8329
+ */
8330
+ minReplies?: number;
8331
+ /**
8332
+ * 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.
8333
+ */
8334
+ minQuotes?: number;
8335
+ /**
8336
+ * 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.
8337
+ */
8338
+ minViews?: number;
8339
+ /**
8340
+ * 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.
8341
+ */
8342
+ minBookmarks?: number;
8343
+ /**
8344
+ * 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.
8345
+ */
8346
+ anyOf?: Array<FilterGroup>;
6867
8347
  };
6868
8348
  /**
6869
- * Daily and weekly alerts only.
8349
+ * Daily and weekly alerts only; null for instant and hourly ones.
6870
8350
  */
6871
8351
  schedule: {
6872
8352
  hour: number;
@@ -6903,7 +8383,7 @@ type ListAlertsResponses = {
6903
8383
  */
6904
8384
  lastSentAt: string | null;
6905
8385
  /**
6906
- * Daily and weekly alerts: the next digest; null when disabled or instant.
8386
+ * Hourly, daily and weekly alerts: the next digest; null when disabled or instant.
6907
8387
  */
6908
8388
  nextRunAt: string | null;
6909
8389
  };
@@ -6919,7 +8399,7 @@ type CreateAlertData = {
6919
8399
  body: {
6920
8400
  name: string;
6921
8401
  enabled?: boolean;
6922
- mode?: 'instant' | 'daily' | 'weekly';
8402
+ mode?: 'instant' | 'hourly' | 'daily' | 'weekly';
6923
8403
  filter?: {
6924
8404
  /**
6925
8405
  * Only these keywords.
@@ -6977,9 +8457,41 @@ type CreateAlertData = {
6977
8457
  * Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
6978
8458
  */
6979
8459
  ratings?: Array<number>;
8460
+ /**
8461
+ * Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
8462
+ */
8463
+ notRatings?: Array<number>;
8464
+ /**
8465
+ * 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.
8466
+ */
8467
+ minLikes?: number;
8468
+ /**
8469
+ * 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.
8470
+ */
8471
+ minReposts?: number;
8472
+ /**
8473
+ * 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.
8474
+ */
8475
+ minReplies?: number;
8476
+ /**
8477
+ * 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.
8478
+ */
8479
+ minQuotes?: number;
8480
+ /**
8481
+ * 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.
8482
+ */
8483
+ minViews?: number;
8484
+ /**
8485
+ * 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.
8486
+ */
8487
+ minBookmarks?: number;
8488
+ /**
8489
+ * 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.
8490
+ */
8491
+ anyOf?: Array<FilterGroup>;
6980
8492
  };
6981
8493
  /**
6982
- * Required for daily and weekly alerts (weekly ones also need schedule.weekday).
8494
+ * Required for daily and weekly alerts (weekly ones also need schedule.weekday). Hourly alerts take none: they send every UTC hour, so a time of day and a zone are ignored and a weekday is refused.
6983
8495
  */
6984
8496
  schedule?: {
6985
8497
  hour: number;
@@ -7006,7 +8518,7 @@ type CreateAlertData = {
7006
8518
  };
7007
8519
  type CreateAlertErrors = {
7008
8520
  /**
7009
- * A daily or weekly rule without a schedule (or a weekly one without a weekday), or an unknown channel
8521
+ * A daily or weekly rule without a schedule (or a weekly one without a weekday), an hourly one with a weekday or an email channel (hourly_email_unsupported), an unknown channel, or anyOf groups binding more values than one query can carry (filter_too_complex)
7010
8522
  */
7011
8523
  400: ErrorResponse;
7012
8524
  /**
@@ -7070,7 +8582,7 @@ type RunAlertDigestData = {
7070
8582
  };
7071
8583
  type RunAlertDigestErrors = {
7072
8584
  /**
7073
- * Only daily and weekly rules have a digest
8585
+ * Only hourly, daily and weekly rules have a digest
7074
8586
  */
7075
8587
  400: ErrorResponse;
7076
8588
  /**
@@ -7085,13 +8597,13 @@ type RunAlertDigestErrors = {
7085
8597
  type RunAlertDigestError = RunAlertDigestErrors[keyof RunAlertDigestErrors];
7086
8598
  type RunAlertDigestResponses = {
7087
8599
  /**
7088
- * The digest for the rule's own period (the last day, or the last week) was sent now (the scheduled one still runs)
8600
+ * The digest for the rule's own period (the last hour, day or week) was sent now (the scheduled one still runs)
7089
8601
  */
7090
8602
  200: {
7091
8603
  /**
7092
- * Why nothing was sent, if nothing was.
8604
+ * Why nothing was sent, if nothing was: the period already went out, the window had nothing to show, (hourly rules) the hour's retry window closed before it could send, or another run of the same period is sending it right now.
7093
8605
  */
7094
- skipped: 'already_sent' | 'empty';
8606
+ skipped: 'already_sent' | 'empty' | 'expired' | 'in_flight';
7095
8607
  matched: number;
7096
8608
  relevant: number;
7097
8609
  outcomes: Array<{
@@ -7536,9 +9048,9 @@ type UpdateChannelData = {
7536
9048
  [key: string]: string;
7537
9049
  };
7538
9050
  /**
7539
- * Webhooks only; replaces the whole set of account events the endpoint receives. An empty list unsubscribes it from all of them.
9051
+ * Replaces the whole set of account events the channel receives. A webhook takes any of them; a Slack, email or Telegram channel the attention events only (mention.spike, sentiment.negative_spike, keyword.noisy, channel.failing). An empty list unsubscribes it from all of them.
7540
9052
  */
7541
- events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed'>;
9053
+ events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
7542
9054
  };
7543
9055
  path: {
7544
9056
  /**
@@ -7550,6 +9062,10 @@ type UpdateChannelData = {
7550
9062
  url: '/v1/channels/{id}';
7551
9063
  };
7552
9064
  type UpdateChannelErrors = {
9065
+ /**
9066
+ * An event this kind of channel cannot receive: Slack, email and Telegram take the attention events only
9067
+ */
9068
+ 400: ErrorResponse;
7553
9069
  /**
7554
9070
  * Missing or invalid API key
7555
9071
  */
@@ -7740,6 +9256,10 @@ type CreateChannelData = {
7740
9256
  url: '/v1/channels';
7741
9257
  };
7742
9258
  type CreateChannelErrors = {
9259
+ /**
9260
+ * An event this kind of channel cannot receive: Slack, email and Telegram take the attention events only
9261
+ */
9262
+ 400: ErrorResponse;
7743
9263
  /**
7744
9264
  * Missing or invalid API key
7745
9265
  */
@@ -7800,6 +9320,12 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
7800
9320
  * 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.
7801
9321
  */
7802
9322
  declare const updateKeyword: <ThrowOnError extends boolean = false>(options: Options<UpdateKeywordData, ThrowOnError>) => RequestResult<UpdateKeywordResponses, UpdateKeywordErrors, ThrowOnError>;
9323
+ /**
9324
+ * Get a keyword's health
9325
+ *
9326
+ * 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.
9327
+ */
9328
+ declare const getKeywordHealth: <ThrowOnError extends boolean = false>(options: Options<GetKeywordHealthData, ThrowOnError>) => RequestResult<GetKeywordHealthResponses, GetKeywordHealthErrors, ThrowOnError>;
7803
9329
  /**
7804
9330
  * Get the workspace filters
7805
9331
  *
@@ -7827,15 +9353,21 @@ declare const updateMention: <ThrowOnError extends boolean = false>(options: Opt
7827
9353
  /**
7828
9354
  * List mentions
7829
9355
  *
7830
- * 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.
9356
+ * 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.
7831
9357
  */
7832
9358
  declare const searchMentions: <ThrowOnError extends boolean = false>(options?: Options<SearchMentionsData, ThrowOnError>) => RequestResult<SearchMentionsResponses, SearchMentionsErrors, ThrowOnError>;
7833
9359
  /**
7834
9360
  * Export mentions as CSV
7835
9361
  *
7836
- * 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.
9362
+ * 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.
7837
9363
  */
7838
9364
  declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
9365
+ /**
9366
+ * Export mentions as JSON
9367
+ *
9368
+ * 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.
9369
+ */
9370
+ declare const exportMentionsJson: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsJsonData, ThrowOnError>) => RequestResult<ExportMentionsJsonResponses, ExportMentionsJsonErrors, ThrowOnError>;
7839
9371
  /**
7840
9372
  * Export people as CSV
7841
9373
  *
@@ -7923,7 +9455,7 @@ declare const listViews: <ThrowOnError extends boolean = false>(options?: Option
7923
9455
  /**
7924
9456
  * Save a view
7925
9457
  *
7926
- * 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.
9458
+ * 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.
7927
9459
  */
7928
9460
  declare const createView: <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => RequestResult<CreateViewResponses, CreateViewErrors, ThrowOnError>;
7929
9461
  /**
@@ -7942,6 +9474,18 @@ declare const getView: <ThrowOnError extends boolean = false>(options: Options<G
7942
9474
  * Rename, describe or refilter a view. `filter` replaces the whole filter.
7943
9475
  */
7944
9476
  declare const updateView: <ThrowOnError extends boolean = false>(options: Options<UpdateViewData, ThrowOnError>) => RequestResult<UpdateViewResponses, UpdateViewErrors, ThrowOnError>;
9477
+ /**
9478
+ * List attention items
9479
+ *
9480
+ * What needs a person, newest first: a keyword whose mentions spiked in the last hour (mention.spike), whose negative share of the last 24 hours jumped (sentiment.negative_spike), that turned noisy (keyword.noisy), or a channel whose last sends all failed (channel.failing). Detected once an hour; an item opens when its condition starts and resolves on its own when the condition is gone. Open items by default; `status=all` reads the history. Each opening is also an account event of the same name, which webhook, Slack, email and Telegram channels can subscribe to.
9481
+ */
9482
+ declare const listAttention: <ThrowOnError extends boolean = false>(options?: Options<ListAttentionData, ThrowOnError>) => RequestResult<ListAttentionResponses, ListAttentionErrors, ThrowOnError>;
9483
+ /**
9484
+ * Dismiss an attention item
9485
+ *
9486
+ * Put an item away. It leaves the open list and does not come back while its condition lasts; once the condition clears, a new episode may open a new item. Idempotent.
9487
+ */
9488
+ declare const dismissAttention: <ThrowOnError extends boolean = false>(options: Options<DismissAttentionData, ThrowOnError>) => RequestResult<DismissAttentionResponses, DismissAttentionErrors, ThrowOnError>;
7945
9489
  /**
7946
9490
  * List groups
7947
9491
  *
@@ -8095,7 +9639,7 @@ declare const listAlerts: <ThrowOnError extends boolean = false>(options?: Optio
8095
9639
  /**
8096
9640
  * Create an alert
8097
9641
  *
8098
- * 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).
9642
+ * A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; hourly sends one digest every UTC hour (five minutes past) for the previous full hour, nothing when it had no mention over the rule's floor, to Slack, Telegram and webhook channels only (no schedule); daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday). filter.anyOf adds OR: groups of conditions in the vocabulary of the mentions list, at least one of which must hold on top of the rest of the filter.
8099
9643
  */
8100
9644
  declare const createAlert: <ThrowOnError extends boolean = false>(options: Options<CreateAlertData, ThrowOnError>) => RequestResult<CreateAlertResponses, CreateAlertErrors, ThrowOnError>;
8101
9645
  /**
@@ -8198,7 +9742,9 @@ declare const sdk_deleteKeyword: typeof deleteKeyword;
8198
9742
  declare const sdk_deletePersonActivity: typeof deletePersonActivity;
8199
9743
  declare const sdk_deleteSegment: typeof deleteSegment;
8200
9744
  declare const sdk_deleteView: typeof deleteView;
9745
+ declare const sdk_dismissAttention: typeof dismissAttention;
8201
9746
  declare const sdk_exportMentionsCsv: typeof exportMentionsCsv;
9747
+ declare const sdk_exportMentionsJson: typeof exportMentionsJson;
8202
9748
  declare const sdk_exportPeopleCsv: typeof exportPeopleCsv;
8203
9749
  declare const sdk_getAlert: typeof getAlert;
8204
9750
  declare const sdk_getAnalyticsBreakdown: typeof getAnalyticsBreakdown;
@@ -8211,6 +9757,7 @@ declare const sdk_getGroup: typeof getGroup;
8211
9757
  declare const sdk_getHealth: typeof getHealth;
8212
9758
  declare const sdk_getInvoiceUrl: typeof getInvoiceUrl;
8213
9759
  declare const sdk_getKeyword: typeof getKeyword;
9760
+ declare const sdk_getKeywordHealth: typeof getKeywordHealth;
8214
9761
  declare const sdk_getMention: typeof getMention;
8215
9762
  declare const sdk_getPerson: typeof getPerson;
8216
9763
  declare const sdk_getReviewsReport: typeof getReviewsReport;
@@ -8222,6 +9769,7 @@ declare const sdk_getView: typeof getView;
8222
9769
  declare const sdk_getWallet: typeof getWallet;
8223
9770
  declare const sdk_listAlerts: typeof listAlerts;
8224
9771
  declare const sdk_listApiKeys: typeof listApiKeys;
9772
+ declare const sdk_listAttention: typeof listAttention;
8225
9773
  declare const sdk_listChannelDeliveries: typeof listChannelDeliveries;
8226
9774
  declare const sdk_listChannels: typeof listChannels;
8227
9775
  declare const sdk_listGroups: typeof listGroups;
@@ -8259,7 +9807,7 @@ declare const sdk_updateSegment: typeof updateSegment;
8259
9807
  declare const sdk_updateView: typeof updateView;
8260
9808
  declare const sdk_whoami: typeof whoami;
8261
9809
  declare namespace sdk {
8262
- 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 };
9810
+ export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_dismissAttention as dismissAttention, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
8263
9811
  }
8264
9812
 
8265
9813
  /**
@@ -8287,4 +9835,4 @@ type Mentio = typeof sdk & {
8287
9835
  };
8288
9836
  declare function createMentio(options: MentioOptions): Mentio;
8289
9837
 
8290
- 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 };
9838
+ export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type AttentionItem, type Channel, type ChannelFailingEventData, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type DismissAttentionData, type DismissAttentionError, type DismissAttentionErrors, type DismissAttentionResponse, type DismissAttentionResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type FilterGroup, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type Invitation, type InvoiceList, type Keyword, type KeywordHealth, type KeywordNoisyEventData, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListAttentionData, type ListAttentionError, type ListAttentionErrors, type ListAttentionResponse, type ListAttentionResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MentionSpikeEventData, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type NegativeSpikeEventData, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };