@mentio-dev/sdk 0.10.1 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1222 -82
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
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' | '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
|
*/
|
|
@@ -663,9 +1024,17 @@ type Mention = {
|
|
|
663
1024
|
*/
|
|
664
1025
|
text: string;
|
|
665
1026
|
/**
|
|
666
|
-
*
|
|
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.
|
|
667
1028
|
*/
|
|
668
|
-
|
|
1029
|
+
title: string | null;
|
|
1030
|
+
/**
|
|
1031
|
+
* A preview image of the post, when the platform sent one with it: a YouTube thumbnail, a DEV cover, a news article's sharing image, a Bluesky link card or image. Null otherwise.
|
|
1032
|
+
*/
|
|
1033
|
+
imageUrl: string | null;
|
|
1034
|
+
/**
|
|
1035
|
+
* Links the post carries, in the order written, at most 20. Empty for a post with none, and for posts ingested before September 2026.
|
|
1036
|
+
*/
|
|
1037
|
+
links: Array<string>;
|
|
669
1038
|
/**
|
|
670
1039
|
* When the post was published.
|
|
671
1040
|
*/
|
|
@@ -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,6 +1521,151 @@ type Segment = {
|
|
|
1152
1521
|
*/
|
|
1153
1522
|
updatedAt: string;
|
|
1154
1523
|
};
|
|
1524
|
+
/**
|
|
1525
|
+
* A group of conditions, all of which must hold: the vocabulary of a view filter, without anyOf.
|
|
1526
|
+
*/
|
|
1527
|
+
type FilterGroup = {
|
|
1528
|
+
/**
|
|
1529
|
+
* Substring in the post text or the author's name.
|
|
1530
|
+
*/
|
|
1531
|
+
q?: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* Only matches of any of these keywords.
|
|
1534
|
+
*/
|
|
1535
|
+
keywordIds?: Array<string>;
|
|
1536
|
+
/**
|
|
1537
|
+
* Never matches of these keywords.
|
|
1538
|
+
*/
|
|
1539
|
+
notKeywordIds?: Array<string>;
|
|
1540
|
+
/**
|
|
1541
|
+
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
1542
|
+
*/
|
|
1543
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
1544
|
+
/**
|
|
1545
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
1546
|
+
*/
|
|
1547
|
+
groupIds?: Array<string>;
|
|
1548
|
+
/**
|
|
1549
|
+
* Never matches of keywords in these groups.
|
|
1550
|
+
*/
|
|
1551
|
+
notGroupIds?: Array<string>;
|
|
1552
|
+
/**
|
|
1553
|
+
* Only posts from any of these platforms.
|
|
1554
|
+
*/
|
|
1555
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
1556
|
+
/**
|
|
1557
|
+
* Never posts from these platforms.
|
|
1558
|
+
*/
|
|
1559
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
1560
|
+
/**
|
|
1561
|
+
* Only mentions in this status: open, ignored, done.
|
|
1562
|
+
*/
|
|
1563
|
+
status?: 'open' | 'ignored' | 'done';
|
|
1564
|
+
/**
|
|
1565
|
+
* true: only mentions the classifier scored relevant; false: only the rest.
|
|
1566
|
+
*/
|
|
1567
|
+
relevant?: boolean;
|
|
1568
|
+
/**
|
|
1569
|
+
* Only mentions scored at least this.
|
|
1570
|
+
*/
|
|
1571
|
+
minRelevance?: number;
|
|
1572
|
+
/**
|
|
1573
|
+
* Only mentions whose classifier confidence is at least this.
|
|
1574
|
+
*/
|
|
1575
|
+
minConfidence?: number;
|
|
1576
|
+
/**
|
|
1577
|
+
* Only these sentiments.
|
|
1578
|
+
*/
|
|
1579
|
+
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
1580
|
+
/**
|
|
1581
|
+
* Never these sentiments; an unscored mention still passes.
|
|
1582
|
+
*/
|
|
1583
|
+
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
1584
|
+
/**
|
|
1585
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
1586
|
+
*/
|
|
1587
|
+
intents?: Array<string>;
|
|
1588
|
+
/**
|
|
1589
|
+
* Never mentions carrying these tags.
|
|
1590
|
+
*/
|
|
1591
|
+
notIntents?: Array<string>;
|
|
1592
|
+
/**
|
|
1593
|
+
* true: only posts that read as machine-made; false: only the rest.
|
|
1594
|
+
*/
|
|
1595
|
+
automated?: boolean;
|
|
1596
|
+
/**
|
|
1597
|
+
* Only posts in any of these languages (ISO 639-1).
|
|
1598
|
+
*/
|
|
1599
|
+
languages?: Array<string>;
|
|
1600
|
+
/**
|
|
1601
|
+
* Never posts in these languages; an unknown language still passes.
|
|
1602
|
+
*/
|
|
1603
|
+
notLanguages?: Array<string>;
|
|
1604
|
+
/**
|
|
1605
|
+
* Only authors your workspace tagged with any of these.
|
|
1606
|
+
*/
|
|
1607
|
+
tags?: Array<string>;
|
|
1608
|
+
/**
|
|
1609
|
+
* Never authors tagged with any of these.
|
|
1610
|
+
*/
|
|
1611
|
+
notTags?: Array<string>;
|
|
1612
|
+
/**
|
|
1613
|
+
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
1614
|
+
*/
|
|
1615
|
+
linkHosts?: Array<string>;
|
|
1616
|
+
/**
|
|
1617
|
+
* Never posts linking to these hosts.
|
|
1618
|
+
*/
|
|
1619
|
+
notLinkHosts?: Array<string>;
|
|
1620
|
+
/**
|
|
1621
|
+
* Only authors with at least this many followers; unknown reach never passes.
|
|
1622
|
+
*/
|
|
1623
|
+
minFollowers?: number;
|
|
1624
|
+
/**
|
|
1625
|
+
* Only authors with at most this many followers; unknown reach never passes.
|
|
1626
|
+
*/
|
|
1627
|
+
maxFollowers?: number;
|
|
1628
|
+
/**
|
|
1629
|
+
* true: only replies and comments; false: only top-level posts.
|
|
1630
|
+
*/
|
|
1631
|
+
isReply?: boolean;
|
|
1632
|
+
/**
|
|
1633
|
+
* Never these authors: display names, handles or profile URLs.
|
|
1634
|
+
*/
|
|
1635
|
+
excludeAuthors?: Array<string>;
|
|
1636
|
+
/**
|
|
1637
|
+
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
1638
|
+
*/
|
|
1639
|
+
ratings?: Array<number>;
|
|
1640
|
+
/**
|
|
1641
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
1642
|
+
*/
|
|
1643
|
+
notRatings?: Array<number>;
|
|
1644
|
+
/**
|
|
1645
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
1646
|
+
*/
|
|
1647
|
+
minLikes?: number;
|
|
1648
|
+
/**
|
|
1649
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
1650
|
+
*/
|
|
1651
|
+
minReposts?: number;
|
|
1652
|
+
/**
|
|
1653
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
1654
|
+
*/
|
|
1655
|
+
minReplies?: number;
|
|
1656
|
+
/**
|
|
1657
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
1658
|
+
*/
|
|
1659
|
+
minQuotes?: number;
|
|
1660
|
+
/**
|
|
1661
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
1662
|
+
*/
|
|
1663
|
+
minViews?: number;
|
|
1664
|
+
/**
|
|
1665
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
1666
|
+
*/
|
|
1667
|
+
minBookmarks?: number;
|
|
1668
|
+
};
|
|
1155
1669
|
type View = {
|
|
1156
1670
|
/**
|
|
1157
1671
|
* View id (vw_...).
|
|
@@ -1272,6 +1786,38 @@ type View = {
|
|
|
1272
1786
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
1273
1787
|
*/
|
|
1274
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>;
|
|
1275
1821
|
};
|
|
1276
1822
|
/**
|
|
1277
1823
|
* ISO 8601 timestamp, UTC.
|
|
@@ -1949,6 +2495,38 @@ type Alert = {
|
|
|
1949
2495
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
1950
2496
|
*/
|
|
1951
2497
|
ratings?: Array<number>;
|
|
2498
|
+
/**
|
|
2499
|
+
* Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
|
|
2500
|
+
*/
|
|
2501
|
+
notRatings?: Array<number>;
|
|
2502
|
+
/**
|
|
2503
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
2504
|
+
*/
|
|
2505
|
+
minLikes?: number;
|
|
2506
|
+
/**
|
|
2507
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
2508
|
+
*/
|
|
2509
|
+
minReposts?: number;
|
|
2510
|
+
/**
|
|
2511
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
2512
|
+
*/
|
|
2513
|
+
minReplies?: number;
|
|
2514
|
+
/**
|
|
2515
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
2516
|
+
*/
|
|
2517
|
+
minQuotes?: number;
|
|
2518
|
+
/**
|
|
2519
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
2520
|
+
*/
|
|
2521
|
+
minViews?: number;
|
|
2522
|
+
/**
|
|
2523
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
2524
|
+
*/
|
|
2525
|
+
minBookmarks?: number;
|
|
2526
|
+
/**
|
|
2527
|
+
* OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
|
|
2528
|
+
*/
|
|
2529
|
+
anyOf?: Array<FilterGroup>;
|
|
1952
2530
|
};
|
|
1953
2531
|
/**
|
|
1954
2532
|
* Daily and weekly alerts only.
|
|
@@ -3178,6 +3756,10 @@ type ListKeywordsResponses = {
|
|
|
3178
3756
|
*/
|
|
3179
3757
|
noisy: boolean;
|
|
3180
3758
|
};
|
|
3759
|
+
/**
|
|
3760
|
+
* The keyword's health over the same 14 days as `noise`, by the rule GET /v1/keywords/{id}/health applies to its own window: paused (muted), capped (at its mention cap), noisy (20 or more scored matches, under 30% relevant), new (under 7 days old and not noisy, or changed in the last 7 days with under 20 scored matches since), quiet (7 days or older, nothing relevant), else healthy. Judged on the matches since the keyword's last change to its matching rules, platforms or context (or its unmute) when that is inside the 14 days, so a keyword tightened today is not flagged on the noise the change removed; `noise` itself keeps the whole 14 days. Always 14 days, while the endpoint reads 30 by default, so the two can differ for the same keyword. The health endpoint says why and what to change.
|
|
3761
|
+
*/
|
|
3762
|
+
health: 'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new';
|
|
3181
3763
|
/**
|
|
3182
3764
|
* What this keyword has cost this calendar month (UTC) at list price: exactly its row in GET /v1/usage/breakdown?month=<this month> (same tables, same rounding). The wallet's ledger, which settles once a day, is what can differ from these list-price numbers, and only by cumulative rounding.
|
|
3183
3765
|
*/
|
|
@@ -3515,6 +4097,52 @@ type UpdateKeywordResponses = {
|
|
|
3515
4097
|
200: Keyword;
|
|
3516
4098
|
};
|
|
3517
4099
|
type UpdateKeywordResponse = UpdateKeywordResponses[keyof UpdateKeywordResponses];
|
|
4100
|
+
type GetKeywordHealthData = {
|
|
4101
|
+
body?: never;
|
|
4102
|
+
path: {
|
|
4103
|
+
/**
|
|
4104
|
+
* Keyword id (kw_...).
|
|
4105
|
+
*/
|
|
4106
|
+
id: string;
|
|
4107
|
+
};
|
|
4108
|
+
query?: {
|
|
4109
|
+
/**
|
|
4110
|
+
* Trailing window of UTC days ending today, by match time: 7d, 30d, 90d (default 30d).
|
|
4111
|
+
*/
|
|
4112
|
+
range?: '7d' | '30d' | '90d';
|
|
4113
|
+
/**
|
|
4114
|
+
* true: also ask a language model for a rewritten context (cached a day per keyword and window, at most 20 model calls an hour per workspace). Default false: every suggestion comes from the rules alone.
|
|
4115
|
+
*/
|
|
4116
|
+
ai?: boolean;
|
|
4117
|
+
};
|
|
4118
|
+
url: '/v1/keywords/{id}/health';
|
|
4119
|
+
};
|
|
4120
|
+
type GetKeywordHealthErrors = {
|
|
4121
|
+
/**
|
|
4122
|
+
* Invalid query parameters
|
|
4123
|
+
*/
|
|
4124
|
+
400: ErrorResponse;
|
|
4125
|
+
/**
|
|
4126
|
+
* Missing or invalid API key
|
|
4127
|
+
*/
|
|
4128
|
+
401: ErrorResponse;
|
|
4129
|
+
/**
|
|
4130
|
+
* Keyword not found
|
|
4131
|
+
*/
|
|
4132
|
+
404: ErrorResponse;
|
|
4133
|
+
/**
|
|
4134
|
+
* More than 30 health reads this minute (rate_limited)
|
|
4135
|
+
*/
|
|
4136
|
+
429: ErrorResponse;
|
|
4137
|
+
};
|
|
4138
|
+
type GetKeywordHealthError = GetKeywordHealthErrors[keyof GetKeywordHealthErrors];
|
|
4139
|
+
type GetKeywordHealthResponses = {
|
|
4140
|
+
/**
|
|
4141
|
+
* The keyword's health report
|
|
4142
|
+
*/
|
|
4143
|
+
200: KeywordHealth;
|
|
4144
|
+
};
|
|
4145
|
+
type GetKeywordHealthResponse = GetKeywordHealthResponses[keyof GetKeywordHealthResponses];
|
|
3518
4146
|
type GetFiltersData = {
|
|
3519
4147
|
body?: never;
|
|
3520
4148
|
path?: never;
|
|
@@ -3623,66 +4251,301 @@ type UpdateMentionData = {
|
|
|
3623
4251
|
*/
|
|
3624
4252
|
body: {
|
|
3625
4253
|
/**
|
|
3626
|
-
* ignored or done to handle it; open to put it back.
|
|
4254
|
+
* ignored or done to handle it; open to put it back.
|
|
4255
|
+
*/
|
|
4256
|
+
status?: 'open' | 'ignored' | 'done';
|
|
4257
|
+
/**
|
|
4258
|
+
* A workspace member (user id), or null to unassign.
|
|
4259
|
+
*/
|
|
4260
|
+
assigneeId?: string | null;
|
|
4261
|
+
/**
|
|
4262
|
+
* ISO 8601 (or epoch ms) until which the mention leaves the feed; null wakes it.
|
|
4263
|
+
*/
|
|
4264
|
+
snoozedUntil?: string;
|
|
4265
|
+
/**
|
|
4266
|
+
* Internal note; null or empty clears it.
|
|
4267
|
+
*/
|
|
4268
|
+
note?: string | null;
|
|
4269
|
+
/**
|
|
4270
|
+
* Your verdict on relevance, correcting the classifier: true sets relevance to 100 and puts a filtered mention back in the relevant feed, false sets it to 0 and takes it out; null withdraws the verdict and restores the classifier's score. Never billed or unbilled. A mention still being classified answers 409 classification_pending.
|
|
4271
|
+
*/
|
|
4272
|
+
relevant?: boolean | null;
|
|
4273
|
+
/**
|
|
4274
|
+
* Your corrected sentiment; null withdraws the correction and restores the classifier's.
|
|
4275
|
+
*/
|
|
4276
|
+
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
4277
|
+
};
|
|
4278
|
+
path: {
|
|
4279
|
+
/**
|
|
4280
|
+
* Mention id (mm_...).
|
|
4281
|
+
*/
|
|
4282
|
+
id: string;
|
|
4283
|
+
};
|
|
4284
|
+
query?: never;
|
|
4285
|
+
url: '/v1/mentions/{id}';
|
|
4286
|
+
};
|
|
4287
|
+
type UpdateMentionErrors = {
|
|
4288
|
+
/**
|
|
4289
|
+
* Assignee is not a member of this organization
|
|
4290
|
+
*/
|
|
4291
|
+
400: ErrorResponse;
|
|
4292
|
+
/**
|
|
4293
|
+
* Missing or invalid API key
|
|
4294
|
+
*/
|
|
4295
|
+
401: ErrorResponse;
|
|
4296
|
+
/**
|
|
4297
|
+
* Mention not found
|
|
4298
|
+
*/
|
|
4299
|
+
404: ErrorResponse;
|
|
4300
|
+
/**
|
|
4301
|
+
* A verdict on a mention the classifier has not scored yet (classification_pending)
|
|
4302
|
+
*/
|
|
4303
|
+
409: ErrorResponse;
|
|
4304
|
+
};
|
|
4305
|
+
type UpdateMentionError = UpdateMentionErrors[keyof UpdateMentionErrors];
|
|
4306
|
+
type UpdateMentionResponses = {
|
|
4307
|
+
/**
|
|
4308
|
+
* The updated mention
|
|
4309
|
+
*/
|
|
4310
|
+
200: Mention;
|
|
4311
|
+
};
|
|
4312
|
+
type UpdateMentionResponse = UpdateMentionResponses[keyof UpdateMentionResponses];
|
|
4313
|
+
type SearchMentionsData = {
|
|
4314
|
+
body?: never;
|
|
4315
|
+
path?: never;
|
|
4316
|
+
query?: {
|
|
4317
|
+
/**
|
|
4318
|
+
* Only matches of this keyword.
|
|
4319
|
+
*/
|
|
4320
|
+
keywordId?: string;
|
|
4321
|
+
/**
|
|
4322
|
+
* Only posts from this platform.
|
|
4323
|
+
*/
|
|
4324
|
+
platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps';
|
|
4325
|
+
/**
|
|
4326
|
+
* Only mentions in this status. Omit for every status.
|
|
4327
|
+
*/
|
|
4328
|
+
status?: 'open' | 'ignored' | 'done';
|
|
4329
|
+
/**
|
|
4330
|
+
* true: only mentions the classifier scored relevant; false: only the rest (unclassified included).
|
|
4331
|
+
*/
|
|
4332
|
+
relevant?: boolean;
|
|
4333
|
+
/**
|
|
4334
|
+
* Only this sentiment.
|
|
4335
|
+
*/
|
|
4336
|
+
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
4337
|
+
/**
|
|
4338
|
+
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
4339
|
+
*/
|
|
4340
|
+
intent?: string;
|
|
4341
|
+
/**
|
|
4342
|
+
* true: only mentions that read as machine-made (a bot account, a scheduled or templated post, AI-written text); false: only the rest, mentions judged before this existed included. Omitted: everything.
|
|
4343
|
+
*/
|
|
4344
|
+
automated?: boolean;
|
|
4345
|
+
/**
|
|
4346
|
+
* Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
|
|
4347
|
+
*/
|
|
4348
|
+
personId?: string;
|
|
4349
|
+
/**
|
|
4350
|
+
* true: include mentions by people you muted, hidden by default.
|
|
4351
|
+
*/
|
|
4352
|
+
includeMuted?: boolean;
|
|
4353
|
+
/**
|
|
4354
|
+
* Only mentions assigned to this workspace member (user id).
|
|
4355
|
+
*/
|
|
4356
|
+
assigneeId?: string;
|
|
4357
|
+
/**
|
|
4358
|
+
* true: only mentions currently snoozed. Otherwise snoozed mentions stay out until they wake.
|
|
4359
|
+
*/
|
|
4360
|
+
snoozed?: boolean;
|
|
4361
|
+
/**
|
|
4362
|
+
* Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
|
|
4363
|
+
*/
|
|
4364
|
+
excludeAuthors?: Array<string> | null;
|
|
4365
|
+
/**
|
|
4366
|
+
* Only mentions scored at least this; unclassified ones are excluded.
|
|
4367
|
+
*/
|
|
4368
|
+
minRelevance?: number | null;
|
|
4369
|
+
/**
|
|
4370
|
+
* Only mentions whose classifier confidence is at least this, 0 to 1. Mentions without a confidence are excluded.
|
|
4371
|
+
*/
|
|
4372
|
+
minConfidence?: number | null;
|
|
4373
|
+
/**
|
|
4374
|
+
* Only authors with at least this many followers. Unknown reach never passes.
|
|
4375
|
+
*/
|
|
4376
|
+
minFollowers?: number | null;
|
|
4377
|
+
/**
|
|
4378
|
+
* Only authors with at most this many followers. Unknown reach never passes.
|
|
4379
|
+
*/
|
|
4380
|
+
maxFollowers?: number | null;
|
|
4381
|
+
/**
|
|
4382
|
+
* true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
|
|
4383
|
+
*/
|
|
4384
|
+
isReply?: boolean;
|
|
4385
|
+
/**
|
|
4386
|
+
* Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404.
|
|
4387
|
+
*/
|
|
4388
|
+
alertId?: string;
|
|
4389
|
+
/**
|
|
4390
|
+
* Apply a saved view's filter (an id from GET /v1/views) on top of the other filters, every condition ANDed: exactly what the view selects. Unknown ids are a 404.
|
|
4391
|
+
*/
|
|
4392
|
+
viewId?: string;
|
|
4393
|
+
/**
|
|
4394
|
+
* Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
|
|
4395
|
+
*/
|
|
4396
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
4397
|
+
/**
|
|
4398
|
+
* Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
|
|
4399
|
+
*/
|
|
4400
|
+
tags?: Array<string> | null;
|
|
4401
|
+
/**
|
|
4402
|
+
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). Repeatable, or comma-separated.
|
|
4403
|
+
*/
|
|
4404
|
+
linkHosts?: Array<string> | null;
|
|
4405
|
+
/**
|
|
4406
|
+
* Only posts from any of these platforms.
|
|
4407
|
+
*/
|
|
4408
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
4409
|
+
/**
|
|
4410
|
+
* Never posts from these platforms.
|
|
4411
|
+
*/
|
|
4412
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps'>;
|
|
4413
|
+
/**
|
|
4414
|
+
* Only matches of any of these keywords.
|
|
4415
|
+
*/
|
|
4416
|
+
keywordIds?: Array<string> | null;
|
|
4417
|
+
/**
|
|
4418
|
+
* Only matches of keywords in any of these groups (grp_...). Repeatable, or comma-separated.
|
|
4419
|
+
*/
|
|
4420
|
+
groupIds?: Array<string> | null;
|
|
4421
|
+
/**
|
|
4422
|
+
* Never matches of keywords in these groups.
|
|
4423
|
+
*/
|
|
4424
|
+
notGroupIds?: Array<string> | null;
|
|
4425
|
+
/**
|
|
4426
|
+
* Never matches of these keywords.
|
|
4427
|
+
*/
|
|
4428
|
+
notKeywordIds?: Array<string> | null;
|
|
4429
|
+
/**
|
|
4430
|
+
* Only these sentiments.
|
|
4431
|
+
*/
|
|
4432
|
+
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
4433
|
+
/**
|
|
4434
|
+
* Never these sentiments. A mention the classifier has not scored yet still passes.
|
|
4435
|
+
*/
|
|
4436
|
+
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
4437
|
+
/**
|
|
4438
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
4439
|
+
*/
|
|
4440
|
+
intents?: Array<string> | null;
|
|
4441
|
+
/**
|
|
4442
|
+
* Never mentions carrying these intent or topic tags.
|
|
4443
|
+
*/
|
|
4444
|
+
notIntents?: Array<string> | null;
|
|
4445
|
+
/**
|
|
4446
|
+
* Never posts linking to these hosts, the host itself or a subdomain of it.
|
|
4447
|
+
*/
|
|
4448
|
+
notLinkHosts?: Array<string> | null;
|
|
4449
|
+
/**
|
|
4450
|
+
* Never authors your workspace tagged with any of these.
|
|
4451
|
+
*/
|
|
4452
|
+
notTags?: Array<string> | null;
|
|
4453
|
+
/**
|
|
4454
|
+
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
4455
|
+
*/
|
|
4456
|
+
languages?: Array<string>;
|
|
4457
|
+
/**
|
|
4458
|
+
* Never posts in these languages. A post whose language is unknown still passes.
|
|
4459
|
+
*/
|
|
4460
|
+
notLanguages?: Array<string>;
|
|
4461
|
+
/**
|
|
4462
|
+
* Only app store reviews with any of these star ratings (1 to 5): ratings=1,2 is the unhappy ones. Every other post fails it.
|
|
4463
|
+
*/
|
|
4464
|
+
ratings?: Array<number>;
|
|
4465
|
+
/**
|
|
4466
|
+
* Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
|
|
4467
|
+
*/
|
|
4468
|
+
notRatings?: Array<number>;
|
|
4469
|
+
/**
|
|
4470
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
4471
|
+
*/
|
|
4472
|
+
minLikes?: number | null;
|
|
4473
|
+
/**
|
|
4474
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
4475
|
+
*/
|
|
4476
|
+
minReposts?: number | null;
|
|
4477
|
+
/**
|
|
4478
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
4479
|
+
*/
|
|
4480
|
+
minReplies?: number | null;
|
|
4481
|
+
/**
|
|
4482
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
4483
|
+
*/
|
|
4484
|
+
minQuotes?: number | null;
|
|
4485
|
+
/**
|
|
4486
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
4487
|
+
*/
|
|
4488
|
+
minViews?: number | null;
|
|
4489
|
+
/**
|
|
4490
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
3627
4491
|
*/
|
|
3628
|
-
|
|
4492
|
+
minBookmarks?: number | null;
|
|
3629
4493
|
/**
|
|
3630
|
-
*
|
|
4494
|
+
* OR across groups of conditions, as URL-encoded JSON: [{"platforms":["reddit"],"sentiments":["negative"]},{"intents":["buy_intent"]}] is "negative on Reddit, or buying intent anywhere". Each group holds the conditions of a view filter (lists any-of, not lists none-of, all ANDed); a mention passes when at least one group holds, and every other filter here still applies. 1 to 10 groups, none empty, no nesting.
|
|
3631
4495
|
*/
|
|
3632
|
-
|
|
4496
|
+
anyOf?: string;
|
|
3633
4497
|
/**
|
|
3634
|
-
*
|
|
4498
|
+
* Substring search in the post text or the author's name.
|
|
3635
4499
|
*/
|
|
3636
|
-
|
|
4500
|
+
q?: string;
|
|
3637
4501
|
/**
|
|
3638
|
-
*
|
|
4502
|
+
* Only posts published at or after this instant (ISO 8601, or epoch ms).
|
|
3639
4503
|
*/
|
|
3640
|
-
|
|
4504
|
+
since?: string;
|
|
3641
4505
|
/**
|
|
3642
|
-
*
|
|
4506
|
+
* Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
3643
4507
|
*/
|
|
3644
|
-
|
|
4508
|
+
until?: string;
|
|
3645
4509
|
/**
|
|
3646
|
-
*
|
|
4510
|
+
* newest: by match time, newest first. priority: by attention score, highest first; priority ranks the last 30 days of matches only, older ones stay reachable under newest. Cursors are specific to a sort.
|
|
3647
4511
|
*/
|
|
3648
|
-
|
|
3649
|
-
};
|
|
3650
|
-
path: {
|
|
4512
|
+
sort?: 'newest' | 'priority';
|
|
3651
4513
|
/**
|
|
3652
|
-
*
|
|
4514
|
+
* nextCursor from the previous page; pass the same filters and sort.
|
|
3653
4515
|
*/
|
|
3654
|
-
|
|
4516
|
+
cursor?: string;
|
|
4517
|
+
/**
|
|
4518
|
+
* Page size, 1 to 100.
|
|
4519
|
+
*/
|
|
4520
|
+
limit?: number;
|
|
3655
4521
|
};
|
|
3656
|
-
|
|
3657
|
-
url: '/v1/mentions/{id}';
|
|
4522
|
+
url: '/v1/mentions';
|
|
3658
4523
|
};
|
|
3659
|
-
type
|
|
4524
|
+
type SearchMentionsErrors = {
|
|
3660
4525
|
/**
|
|
3661
|
-
*
|
|
4526
|
+
* Invalid query or pagination cursor, or filter_too_complex: the filters together (anyOf groups, a view or rule on top) name more values than one query can carry
|
|
3662
4527
|
*/
|
|
3663
4528
|
400: ErrorResponse;
|
|
3664
4529
|
/**
|
|
3665
4530
|
* Missing or invalid API key
|
|
3666
4531
|
*/
|
|
3667
4532
|
401: ErrorResponse;
|
|
3668
|
-
/**
|
|
3669
|
-
* Mention not found
|
|
3670
|
-
*/
|
|
3671
|
-
404: ErrorResponse;
|
|
3672
|
-
/**
|
|
3673
|
-
* A verdict on a mention the classifier has not scored yet (classification_pending)
|
|
3674
|
-
*/
|
|
3675
|
-
409: ErrorResponse;
|
|
3676
4533
|
};
|
|
3677
|
-
type
|
|
3678
|
-
type
|
|
4534
|
+
type SearchMentionsError = SearchMentionsErrors[keyof SearchMentionsErrors];
|
|
4535
|
+
type SearchMentionsResponses = {
|
|
3679
4536
|
/**
|
|
3680
|
-
*
|
|
4537
|
+
* One page of mentions in the requested order
|
|
3681
4538
|
*/
|
|
3682
|
-
200:
|
|
4539
|
+
200: {
|
|
4540
|
+
data: Array<Mention>;
|
|
4541
|
+
/**
|
|
4542
|
+
* Pass as cursor for the next page; null on the last page.
|
|
4543
|
+
*/
|
|
4544
|
+
nextCursor: string | null;
|
|
4545
|
+
};
|
|
3683
4546
|
};
|
|
3684
|
-
type
|
|
3685
|
-
type
|
|
4547
|
+
type SearchMentionsResponse = SearchMentionsResponses[keyof SearchMentionsResponses];
|
|
4548
|
+
type ExportMentionsCsvData = {
|
|
3686
4549
|
body?: never;
|
|
3687
4550
|
path?: never;
|
|
3688
4551
|
query?: {
|
|
@@ -3707,7 +4570,7 @@ type SearchMentionsData = {
|
|
|
3707
4570
|
*/
|
|
3708
4571
|
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
3709
4572
|
/**
|
|
3710
|
-
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
|
|
4573
|
+
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
3711
4574
|
*/
|
|
3712
4575
|
intent?: string;
|
|
3713
4576
|
/**
|
|
@@ -3835,57 +4698,75 @@ type SearchMentionsData = {
|
|
|
3835
4698
|
*/
|
|
3836
4699
|
ratings?: Array<number>;
|
|
3837
4700
|
/**
|
|
3838
|
-
*
|
|
4701
|
+
* Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
|
|
3839
4702
|
*/
|
|
3840
|
-
|
|
4703
|
+
notRatings?: Array<number>;
|
|
3841
4704
|
/**
|
|
3842
|
-
* Only posts
|
|
4705
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
3843
4706
|
*/
|
|
3844
|
-
|
|
4707
|
+
minLikes?: number | null;
|
|
3845
4708
|
/**
|
|
3846
|
-
* Only posts
|
|
4709
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
3847
4710
|
*/
|
|
3848
|
-
|
|
4711
|
+
minReposts?: number | null;
|
|
3849
4712
|
/**
|
|
3850
|
-
*
|
|
4713
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
3851
4714
|
*/
|
|
3852
|
-
|
|
4715
|
+
minReplies?: number | null;
|
|
3853
4716
|
/**
|
|
3854
|
-
*
|
|
4717
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
3855
4718
|
*/
|
|
3856
|
-
|
|
4719
|
+
minQuotes?: number | null;
|
|
3857
4720
|
/**
|
|
3858
|
-
*
|
|
4721
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
3859
4722
|
*/
|
|
3860
|
-
|
|
4723
|
+
minViews?: number | null;
|
|
4724
|
+
/**
|
|
4725
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
4726
|
+
*/
|
|
4727
|
+
minBookmarks?: number | null;
|
|
4728
|
+
/**
|
|
4729
|
+
* OR across groups of conditions, as URL-encoded JSON: [{"platforms":["reddit"],"sentiments":["negative"]},{"intents":["buy_intent"]}] is "negative on Reddit, or buying intent anywhere". Each group holds the conditions of a view filter (lists any-of, not lists none-of, all ANDed); a mention passes when at least one group holds, and every other filter here still applies. 1 to 10 groups, none empty, no nesting.
|
|
4730
|
+
*/
|
|
4731
|
+
anyOf?: string;
|
|
4732
|
+
/**
|
|
4733
|
+
* Substring search in the post text or the author's name.
|
|
4734
|
+
*/
|
|
4735
|
+
q?: string;
|
|
4736
|
+
/**
|
|
4737
|
+
* Only posts published at or after this instant (ISO 8601, or epoch ms).
|
|
4738
|
+
*/
|
|
4739
|
+
since?: string;
|
|
4740
|
+
/**
|
|
4741
|
+
* Only posts published at or before this instant (ISO 8601, or epoch ms).
|
|
4742
|
+
*/
|
|
4743
|
+
until?: string;
|
|
3861
4744
|
};
|
|
3862
|
-
url: '/v1/mentions';
|
|
4745
|
+
url: '/v1/mentions/export.csv';
|
|
3863
4746
|
};
|
|
3864
|
-
type
|
|
4747
|
+
type ExportMentionsCsvErrors = {
|
|
3865
4748
|
/**
|
|
3866
|
-
* Invalid query or
|
|
4749
|
+
* Invalid query, or filter_too_complex: the filters together name more values than one query can carry
|
|
3867
4750
|
*/
|
|
3868
4751
|
400: ErrorResponse;
|
|
3869
4752
|
/**
|
|
3870
4753
|
* Missing or invalid API key
|
|
3871
4754
|
*/
|
|
3872
4755
|
401: ErrorResponse;
|
|
4756
|
+
/**
|
|
4757
|
+
* More than 6 exports this minute; retry after the Retry-After seconds
|
|
4758
|
+
*/
|
|
4759
|
+
429: ErrorResponse;
|
|
3873
4760
|
};
|
|
3874
|
-
type
|
|
3875
|
-
type
|
|
4761
|
+
type ExportMentionsCsvError = ExportMentionsCsvErrors[keyof ExportMentionsCsvErrors];
|
|
4762
|
+
type ExportMentionsCsvResponses = {
|
|
3876
4763
|
/**
|
|
3877
|
-
*
|
|
4764
|
+
* CSV, UTF-8
|
|
3878
4765
|
*/
|
|
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
|
-
};
|
|
4766
|
+
200: string;
|
|
3886
4767
|
};
|
|
3887
|
-
type
|
|
3888
|
-
type
|
|
4768
|
+
type ExportMentionsCsvResponse = ExportMentionsCsvResponses[keyof ExportMentionsCsvResponses];
|
|
4769
|
+
type ExportMentionsJsonData = {
|
|
3889
4770
|
body?: never;
|
|
3890
4771
|
path?: never;
|
|
3891
4772
|
query?: {
|
|
@@ -3910,7 +4791,7 @@ type ExportMentionsCsvData = {
|
|
|
3910
4791
|
*/
|
|
3911
4792
|
sentiment?: 'positive' | 'neutral' | 'negative';
|
|
3912
4793
|
/**
|
|
3913
|
-
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional).
|
|
4794
|
+
* Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
|
|
3914
4795
|
*/
|
|
3915
4796
|
intent?: string;
|
|
3916
4797
|
/**
|
|
@@ -4037,6 +4918,38 @@ type ExportMentionsCsvData = {
|
|
|
4037
4918
|
* Only app store reviews with any of these star ratings (1 to 5): ratings=1,2 is the unhappy ones. Every other post fails it.
|
|
4038
4919
|
*/
|
|
4039
4920
|
ratings?: Array<number>;
|
|
4921
|
+
/**
|
|
4922
|
+
* Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
|
|
4923
|
+
*/
|
|
4924
|
+
notRatings?: Array<number>;
|
|
4925
|
+
/**
|
|
4926
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
4927
|
+
*/
|
|
4928
|
+
minLikes?: number | null;
|
|
4929
|
+
/**
|
|
4930
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
4931
|
+
*/
|
|
4932
|
+
minReposts?: number | null;
|
|
4933
|
+
/**
|
|
4934
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
4935
|
+
*/
|
|
4936
|
+
minReplies?: number | null;
|
|
4937
|
+
/**
|
|
4938
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
4939
|
+
*/
|
|
4940
|
+
minQuotes?: number | null;
|
|
4941
|
+
/**
|
|
4942
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
4943
|
+
*/
|
|
4944
|
+
minViews?: number | null;
|
|
4945
|
+
/**
|
|
4946
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
4947
|
+
*/
|
|
4948
|
+
minBookmarks?: number | null;
|
|
4949
|
+
/**
|
|
4950
|
+
* OR across groups of conditions, as URL-encoded JSON: [{"platforms":["reddit"],"sentiments":["negative"]},{"intents":["buy_intent"]}] is "negative on Reddit, or buying intent anywhere". Each group holds the conditions of a view filter (lists any-of, not lists none-of, all ANDed); a mention passes when at least one group holds, and every other filter here still applies. 1 to 10 groups, none empty, no nesting.
|
|
4951
|
+
*/
|
|
4952
|
+
anyOf?: string;
|
|
4040
4953
|
/**
|
|
4041
4954
|
* Substring search in the post text or the author's name.
|
|
4042
4955
|
*/
|
|
@@ -4050,11 +4963,11 @@ type ExportMentionsCsvData = {
|
|
|
4050
4963
|
*/
|
|
4051
4964
|
until?: string;
|
|
4052
4965
|
};
|
|
4053
|
-
url: '/v1/mentions/export.
|
|
4966
|
+
url: '/v1/mentions/export.json';
|
|
4054
4967
|
};
|
|
4055
|
-
type
|
|
4968
|
+
type ExportMentionsJsonErrors = {
|
|
4056
4969
|
/**
|
|
4057
|
-
* Invalid query
|
|
4970
|
+
* Invalid query, or filter_too_complex: the filters together name more values than one query can carry
|
|
4058
4971
|
*/
|
|
4059
4972
|
400: ErrorResponse;
|
|
4060
4973
|
/**
|
|
@@ -4066,14 +4979,23 @@ type ExportMentionsCsvErrors = {
|
|
|
4066
4979
|
*/
|
|
4067
4980
|
429: ErrorResponse;
|
|
4068
4981
|
};
|
|
4069
|
-
type
|
|
4070
|
-
type
|
|
4982
|
+
type ExportMentionsJsonError = ExportMentionsJsonErrors[keyof ExportMentionsJsonErrors];
|
|
4983
|
+
type ExportMentionsJsonResponses = {
|
|
4071
4984
|
/**
|
|
4072
|
-
*
|
|
4985
|
+
* Every matching mention, up to the cap
|
|
4073
4986
|
*/
|
|
4074
|
-
200:
|
|
4987
|
+
200: {
|
|
4988
|
+
/**
|
|
4989
|
+
* At most 10,000 mentions, newest matched first.
|
|
4990
|
+
*/
|
|
4991
|
+
data: Array<Mention>;
|
|
4992
|
+
/**
|
|
4993
|
+
* true when more mentions matched than the cap returns: narrow the filters (since, until) and export again.
|
|
4994
|
+
*/
|
|
4995
|
+
truncated: boolean;
|
|
4996
|
+
};
|
|
4075
4997
|
};
|
|
4076
|
-
type
|
|
4998
|
+
type ExportMentionsJsonResponse = ExportMentionsJsonResponses[keyof ExportMentionsJsonResponses];
|
|
4077
4999
|
type ExportPeopleCsvData = {
|
|
4078
5000
|
body?: never;
|
|
4079
5001
|
path?: never;
|
|
@@ -4086,6 +5008,10 @@ type ExportPeopleCsvData = {
|
|
|
4086
5008
|
* Matches the display name or the profile handle or URL, case-insensitively.
|
|
4087
5009
|
*/
|
|
4088
5010
|
q?: string;
|
|
5011
|
+
/**
|
|
5012
|
+
* Find a person by one of their accounts: a handle (@jane, u/jane, jane) or a profile or post link (https://x.com/jane). Exact, case-insensitive, merged accounts included; combine with platform to pick one platform. A link names its own platform.
|
|
5013
|
+
*/
|
|
5014
|
+
handle?: string;
|
|
4089
5015
|
/**
|
|
4090
5016
|
* Only people carrying this tag (exact, case-sensitive).
|
|
4091
5017
|
*/
|
|
@@ -4215,6 +5141,10 @@ type ListPeopleData = {
|
|
|
4215
5141
|
* Matches the display name or the profile handle or URL, case-insensitively.
|
|
4216
5142
|
*/
|
|
4217
5143
|
q?: string;
|
|
5144
|
+
/**
|
|
5145
|
+
* Find a person by one of their accounts: a handle (@jane, u/jane, jane) or a profile or post link (https://x.com/jane). Exact, case-insensitive, merged accounts included; combine with platform to pick one platform. A link names its own platform.
|
|
5146
|
+
*/
|
|
5147
|
+
handle?: string;
|
|
4218
5148
|
/**
|
|
4219
5149
|
* Only people carrying this tag (exact, case-sensitive).
|
|
4220
5150
|
*/
|
|
@@ -5395,6 +6325,38 @@ type ListViewsResponses = {
|
|
|
5395
6325
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
5396
6326
|
*/
|
|
5397
6327
|
ratings?: Array<number>;
|
|
6328
|
+
/**
|
|
6329
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
6330
|
+
*/
|
|
6331
|
+
notRatings?: Array<number>;
|
|
6332
|
+
/**
|
|
6333
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
6334
|
+
*/
|
|
6335
|
+
minLikes?: number;
|
|
6336
|
+
/**
|
|
6337
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
6338
|
+
*/
|
|
6339
|
+
minReposts?: number;
|
|
6340
|
+
/**
|
|
6341
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
6342
|
+
*/
|
|
6343
|
+
minReplies?: number;
|
|
6344
|
+
/**
|
|
6345
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
6346
|
+
*/
|
|
6347
|
+
minQuotes?: number;
|
|
6348
|
+
/**
|
|
6349
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
6350
|
+
*/
|
|
6351
|
+
minViews?: number;
|
|
6352
|
+
/**
|
|
6353
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
6354
|
+
*/
|
|
6355
|
+
minBookmarks?: number;
|
|
6356
|
+
/**
|
|
6357
|
+
* OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
|
|
6358
|
+
*/
|
|
6359
|
+
anyOf?: Array<FilterGroup>;
|
|
5398
6360
|
};
|
|
5399
6361
|
/**
|
|
5400
6362
|
* ISO 8601 timestamp, UTC.
|
|
@@ -5534,6 +6496,38 @@ type CreateViewData = {
|
|
|
5534
6496
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
5535
6497
|
*/
|
|
5536
6498
|
ratings?: Array<number>;
|
|
6499
|
+
/**
|
|
6500
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
6501
|
+
*/
|
|
6502
|
+
notRatings?: Array<number>;
|
|
6503
|
+
/**
|
|
6504
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
6505
|
+
*/
|
|
6506
|
+
minLikes?: number;
|
|
6507
|
+
/**
|
|
6508
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
6509
|
+
*/
|
|
6510
|
+
minReposts?: number;
|
|
6511
|
+
/**
|
|
6512
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
6513
|
+
*/
|
|
6514
|
+
minReplies?: number;
|
|
6515
|
+
/**
|
|
6516
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
6517
|
+
*/
|
|
6518
|
+
minQuotes?: number;
|
|
6519
|
+
/**
|
|
6520
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
6521
|
+
*/
|
|
6522
|
+
minViews?: number;
|
|
6523
|
+
/**
|
|
6524
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
6525
|
+
*/
|
|
6526
|
+
minBookmarks?: number;
|
|
6527
|
+
/**
|
|
6528
|
+
* OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
|
|
6529
|
+
*/
|
|
6530
|
+
anyOf?: Array<FilterGroup>;
|
|
5537
6531
|
};
|
|
5538
6532
|
};
|
|
5539
6533
|
path?: never;
|
|
@@ -5541,6 +6535,10 @@ type CreateViewData = {
|
|
|
5541
6535
|
url: '/v1/views';
|
|
5542
6536
|
};
|
|
5543
6537
|
type CreateViewErrors = {
|
|
6538
|
+
/**
|
|
6539
|
+
* Invalid filter (an empty anyOf group, for one), or filter_too_complex: more values than one query can carry
|
|
6540
|
+
*/
|
|
6541
|
+
400: ErrorResponse;
|
|
5544
6542
|
/**
|
|
5545
6543
|
* Missing or invalid API key
|
|
5546
6544
|
*/
|
|
@@ -5736,6 +6734,38 @@ type UpdateViewData = {
|
|
|
5736
6734
|
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
5737
6735
|
*/
|
|
5738
6736
|
ratings?: Array<number>;
|
|
6737
|
+
/**
|
|
6738
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
6739
|
+
*/
|
|
6740
|
+
notRatings?: Array<number>;
|
|
6741
|
+
/**
|
|
6742
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
6743
|
+
*/
|
|
6744
|
+
minLikes?: number;
|
|
6745
|
+
/**
|
|
6746
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
6747
|
+
*/
|
|
6748
|
+
minReposts?: number;
|
|
6749
|
+
/**
|
|
6750
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
6751
|
+
*/
|
|
6752
|
+
minReplies?: number;
|
|
6753
|
+
/**
|
|
6754
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
6755
|
+
*/
|
|
6756
|
+
minQuotes?: number;
|
|
6757
|
+
/**
|
|
6758
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
6759
|
+
*/
|
|
6760
|
+
minViews?: number;
|
|
6761
|
+
/**
|
|
6762
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
6763
|
+
*/
|
|
6764
|
+
minBookmarks?: number;
|
|
6765
|
+
/**
|
|
6766
|
+
* OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
|
|
6767
|
+
*/
|
|
6768
|
+
anyOf?: Array<FilterGroup>;
|
|
5739
6769
|
};
|
|
5740
6770
|
};
|
|
5741
6771
|
path: {
|
|
@@ -6730,6 +7760,38 @@ type UpdateAlertData = {
|
|
|
6730
7760
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
6731
7761
|
*/
|
|
6732
7762
|
ratings?: Array<number>;
|
|
7763
|
+
/**
|
|
7764
|
+
* Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
|
|
7765
|
+
*/
|
|
7766
|
+
notRatings?: Array<number>;
|
|
7767
|
+
/**
|
|
7768
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
7769
|
+
*/
|
|
7770
|
+
minLikes?: number;
|
|
7771
|
+
/**
|
|
7772
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
7773
|
+
*/
|
|
7774
|
+
minReposts?: number;
|
|
7775
|
+
/**
|
|
7776
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
7777
|
+
*/
|
|
7778
|
+
minReplies?: number;
|
|
7779
|
+
/**
|
|
7780
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
7781
|
+
*/
|
|
7782
|
+
minQuotes?: number;
|
|
7783
|
+
/**
|
|
7784
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
7785
|
+
*/
|
|
7786
|
+
minViews?: number;
|
|
7787
|
+
/**
|
|
7788
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
7789
|
+
*/
|
|
7790
|
+
minBookmarks?: number;
|
|
7791
|
+
/**
|
|
7792
|
+
* OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
|
|
7793
|
+
*/
|
|
7794
|
+
anyOf?: Array<FilterGroup>;
|
|
6733
7795
|
};
|
|
6734
7796
|
schedule?: {
|
|
6735
7797
|
hour: number;
|
|
@@ -6864,6 +7926,38 @@ type ListAlertsResponses = {
|
|
|
6864
7926
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
6865
7927
|
*/
|
|
6866
7928
|
ratings?: Array<number>;
|
|
7929
|
+
/**
|
|
7930
|
+
* Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
|
|
7931
|
+
*/
|
|
7932
|
+
notRatings?: Array<number>;
|
|
7933
|
+
/**
|
|
7934
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
7935
|
+
*/
|
|
7936
|
+
minLikes?: number;
|
|
7937
|
+
/**
|
|
7938
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
7939
|
+
*/
|
|
7940
|
+
minReposts?: number;
|
|
7941
|
+
/**
|
|
7942
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
7943
|
+
*/
|
|
7944
|
+
minReplies?: number;
|
|
7945
|
+
/**
|
|
7946
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
7947
|
+
*/
|
|
7948
|
+
minQuotes?: number;
|
|
7949
|
+
/**
|
|
7950
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
7951
|
+
*/
|
|
7952
|
+
minViews?: number;
|
|
7953
|
+
/**
|
|
7954
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
7955
|
+
*/
|
|
7956
|
+
minBookmarks?: number;
|
|
7957
|
+
/**
|
|
7958
|
+
* OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
|
|
7959
|
+
*/
|
|
7960
|
+
anyOf?: Array<FilterGroup>;
|
|
6867
7961
|
};
|
|
6868
7962
|
/**
|
|
6869
7963
|
* Daily and weekly alerts only.
|
|
@@ -6977,6 +8071,38 @@ type CreateAlertData = {
|
|
|
6977
8071
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
6978
8072
|
*/
|
|
6979
8073
|
ratings?: Array<number>;
|
|
8074
|
+
/**
|
|
8075
|
+
* Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.
|
|
8076
|
+
*/
|
|
8077
|
+
notRatings?: Array<number>;
|
|
8078
|
+
/**
|
|
8079
|
+
* Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
|
|
8080
|
+
*/
|
|
8081
|
+
minLikes?: number;
|
|
8082
|
+
/**
|
|
8083
|
+
* Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
|
|
8084
|
+
*/
|
|
8085
|
+
minReposts?: number;
|
|
8086
|
+
/**
|
|
8087
|
+
* Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
|
|
8088
|
+
*/
|
|
8089
|
+
minReplies?: number;
|
|
8090
|
+
/**
|
|
8091
|
+
* Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
|
|
8092
|
+
*/
|
|
8093
|
+
minQuotes?: number;
|
|
8094
|
+
/**
|
|
8095
|
+
* Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
|
|
8096
|
+
*/
|
|
8097
|
+
minViews?: number;
|
|
8098
|
+
/**
|
|
8099
|
+
* Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
|
|
8100
|
+
*/
|
|
8101
|
+
minBookmarks?: number;
|
|
8102
|
+
/**
|
|
8103
|
+
* OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.
|
|
8104
|
+
*/
|
|
8105
|
+
anyOf?: Array<FilterGroup>;
|
|
6980
8106
|
};
|
|
6981
8107
|
/**
|
|
6982
8108
|
* Required for daily and weekly alerts (weekly ones also need schedule.weekday).
|
|
@@ -7006,7 +8132,7 @@ type CreateAlertData = {
|
|
|
7006
8132
|
};
|
|
7007
8133
|
type CreateAlertErrors = {
|
|
7008
8134
|
/**
|
|
7009
|
-
* A daily or weekly rule without a schedule (or a weekly one without a weekday),
|
|
8135
|
+
* A daily or weekly rule without a schedule (or a weekly one without a weekday), an unknown channel, or anyOf groups binding more values than one query can carry (filter_too_complex)
|
|
7010
8136
|
*/
|
|
7011
8137
|
400: ErrorResponse;
|
|
7012
8138
|
/**
|
|
@@ -7800,6 +8926,12 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
|
|
|
7800
8926
|
* Mute or unmute it, reclassify it (`kind`), change the platforms it is tracked on, its classifier `context`, its `matching` rules (each rule field optional; an empty list clears one), or its monthly mention `cap` (null removes it; a cap above this month's count resumes a capped keyword at once). Rules apply to new mentions from the next poll; stored mentions are untouched.
|
|
7801
8927
|
*/
|
|
7802
8928
|
declare const updateKeyword: <ThrowOnError extends boolean = false>(options: Options<UpdateKeywordData, ThrowOnError>) => RequestResult<UpdateKeywordResponses, UpdateKeywordErrors, ThrowOnError>;
|
|
8929
|
+
/**
|
|
8930
|
+
* Get a keyword's health
|
|
8931
|
+
*
|
|
8932
|
+
* Whether the keyword earns what it costs over a trailing window (`range`, default 30d): a status (healthy, noisy, quiet, capped, paused, new) with the reasons in plain words, its numbers by platform and week, what it cost, the words and authors its noise is made of, and suggestions. Each suggestion carries a `patch` to send to PATCH /v1/keywords/{id} as is, and the effect it would have had, measured by running the matcher's own rules over the window's posts. `ai=true` adds a context rewritten by a language model (cached a day, at most 20 model calls an hour per workspace). Read only and never billed; the report is cached for 5 minutes, and a change to the keyword starts a fresh one. At most 30 reads a minute per workspace.
|
|
8933
|
+
*/
|
|
8934
|
+
declare const getKeywordHealth: <ThrowOnError extends boolean = false>(options: Options<GetKeywordHealthData, ThrowOnError>) => RequestResult<GetKeywordHealthResponses, GetKeywordHealthErrors, ThrowOnError>;
|
|
7803
8935
|
/**
|
|
7804
8936
|
* Get the workspace filters
|
|
7805
8937
|
*
|
|
@@ -7827,15 +8959,21 @@ declare const updateMention: <ThrowOnError extends boolean = false>(options: Opt
|
|
|
7827
8959
|
/**
|
|
7828
8960
|
* List mentions
|
|
7829
8961
|
*
|
|
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.
|
|
8962
|
+
* Mentions matched to your keywords, filtered and paginated. Default order is newest match first; sort=priority ranks the last 30 days of matches by attention score. Page with nextCursor, passing the same filters and sort. A mention is one post matched to one keyword. alertId applies an alert rule's filter on top of the others: the same mentions that rule would send. anyOf adds OR: URL-encoded JSON groups of conditions, at least one of which must hold on top of every other filter.
|
|
7831
8963
|
*/
|
|
7832
8964
|
declare const searchMentions: <ThrowOnError extends boolean = false>(options?: Options<SearchMentionsData, ThrowOnError>) => RequestResult<SearchMentionsResponses, SearchMentionsErrors, ThrowOnError>;
|
|
7833
8965
|
/**
|
|
7834
8966
|
* Export mentions as CSV
|
|
7835
8967
|
*
|
|
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.
|
|
8968
|
+
* The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them). Capped at 10,000 rows; the X-Mentions-Truncated header says when the cap cut the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
|
|
7837
8969
|
*/
|
|
7838
8970
|
declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
|
|
8971
|
+
/**
|
|
8972
|
+
* Export mentions as JSON
|
|
8973
|
+
*
|
|
8974
|
+
* The same mentions GET /v1/mentions would list for these filters, in one response, newest matched first (the order they entered your feed): every row is the full Mention object the list returns, text included. Capped at 10,000 mentions; `truncated` (and the X-Mentions-Truncated header) says when the cap cut the list. Shares the CSV export's limit: at most 6 exports per minute per workspace, either format; a 429 carries Retry-After.
|
|
8975
|
+
*/
|
|
8976
|
+
declare const exportMentionsJson: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsJsonData, ThrowOnError>) => RequestResult<ExportMentionsJsonResponses, ExportMentionsJsonErrors, ThrowOnError>;
|
|
7839
8977
|
/**
|
|
7840
8978
|
* Export people as CSV
|
|
7841
8979
|
*
|
|
@@ -7923,7 +9061,7 @@ declare const listViews: <ThrowOnError extends boolean = false>(options?: Option
|
|
|
7923
9061
|
/**
|
|
7924
9062
|
* Save a view
|
|
7925
9063
|
*
|
|
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.
|
|
9064
|
+
* Save a named filter over mentions. The filter takes the same fields as GET /v1/mentions (lists are any-of, `not` lists none-of, every condition ANDed), plus `anyOf`, groups of those conditions of which at least one must hold; an empty filter is every mention. Nothing is materialized: the view selects whatever matches when it is read.
|
|
7927
9065
|
*/
|
|
7928
9066
|
declare const createView: <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => RequestResult<CreateViewResponses, CreateViewErrors, ThrowOnError>;
|
|
7929
9067
|
/**
|
|
@@ -8095,7 +9233,7 @@ declare const listAlerts: <ThrowOnError extends boolean = false>(options?: Optio
|
|
|
8095
9233
|
/**
|
|
8096
9234
|
* Create an alert
|
|
8097
9235
|
*
|
|
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).
|
|
9236
|
+
* A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday). filter.anyOf adds OR: groups of conditions in the vocabulary of the mentions list, at least one of which must hold on top of the rest of the filter.
|
|
8099
9237
|
*/
|
|
8100
9238
|
declare const createAlert: <ThrowOnError extends boolean = false>(options: Options<CreateAlertData, ThrowOnError>) => RequestResult<CreateAlertResponses, CreateAlertErrors, ThrowOnError>;
|
|
8101
9239
|
/**
|
|
@@ -8199,6 +9337,7 @@ declare const sdk_deletePersonActivity: typeof deletePersonActivity;
|
|
|
8199
9337
|
declare const sdk_deleteSegment: typeof deleteSegment;
|
|
8200
9338
|
declare const sdk_deleteView: typeof deleteView;
|
|
8201
9339
|
declare const sdk_exportMentionsCsv: typeof exportMentionsCsv;
|
|
9340
|
+
declare const sdk_exportMentionsJson: typeof exportMentionsJson;
|
|
8202
9341
|
declare const sdk_exportPeopleCsv: typeof exportPeopleCsv;
|
|
8203
9342
|
declare const sdk_getAlert: typeof getAlert;
|
|
8204
9343
|
declare const sdk_getAnalyticsBreakdown: typeof getAnalyticsBreakdown;
|
|
@@ -8211,6 +9350,7 @@ declare const sdk_getGroup: typeof getGroup;
|
|
|
8211
9350
|
declare const sdk_getHealth: typeof getHealth;
|
|
8212
9351
|
declare const sdk_getInvoiceUrl: typeof getInvoiceUrl;
|
|
8213
9352
|
declare const sdk_getKeyword: typeof getKeyword;
|
|
9353
|
+
declare const sdk_getKeywordHealth: typeof getKeywordHealth;
|
|
8214
9354
|
declare const sdk_getMention: typeof getMention;
|
|
8215
9355
|
declare const sdk_getPerson: typeof getPerson;
|
|
8216
9356
|
declare const sdk_getReviewsReport: typeof getReviewsReport;
|
|
@@ -8259,7 +9399,7 @@ declare const sdk_updateSegment: typeof updateSegment;
|
|
|
8259
9399
|
declare const sdk_updateView: typeof updateView;
|
|
8260
9400
|
declare const sdk_whoami: typeof whoami;
|
|
8261
9401
|
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 };
|
|
9402
|
+
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
|
|
8263
9403
|
}
|
|
8264
9404
|
|
|
8265
9405
|
/**
|
|
@@ -8287,4 +9427,4 @@ type Mentio = typeof sdk & {
|
|
|
8287
9427
|
};
|
|
8288
9428
|
declare function createMentio(options: MentioOptions): Mentio;
|
|
8289
9429
|
|
|
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 };
|
|
9430
|
+
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type Channel, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type FilterGroup, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type Invitation, type InvoiceList, type Keyword, type KeywordHealth, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|