@mentio-dev/sdk 0.13.3 → 0.13.5
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 +207 -52
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1303,7 +1303,7 @@ type Mention = {
|
|
|
1303
1303
|
*/
|
|
1304
1304
|
followers: number | null;
|
|
1305
1305
|
/**
|
|
1306
|
-
* Your
|
|
1306
|
+
* Your tags on this person: the workspace's, then those the mention's own keyword group gave them (set with groupId on /v1/people), each once.
|
|
1307
1307
|
*/
|
|
1308
1308
|
tags: Array<string>;
|
|
1309
1309
|
} | null;
|
|
@@ -1385,6 +1385,14 @@ type Mention = {
|
|
|
1385
1385
|
* The language the post is written in, as an ISO 639-1 code (en, es, de); null when unknown or classified before languages were recorded.
|
|
1386
1386
|
*/
|
|
1387
1387
|
language: string | null;
|
|
1388
|
+
/**
|
|
1389
|
+
* Where the author is, as a lowercase ISO 3166-1 alpha-2 code (us, in, de): the classifier's reading of the author's profile location and the post. A best guess, not a fact the platform gave; null when nothing tells, or classified before countries were recorded.
|
|
1390
|
+
*/
|
|
1391
|
+
country: string | null;
|
|
1392
|
+
/**
|
|
1393
|
+
* The author is a company, brand or organization account rather than a person: a LinkedIn company page, a GitHub organization, an account that speaks for a business. A label only, like automated. false while unjudged.
|
|
1394
|
+
*/
|
|
1395
|
+
organization: boolean;
|
|
1388
1396
|
/**
|
|
1389
1397
|
* How sure the classifier is of its relevance verdict, 0 to 1. null when the verdict came without one: the fallback model judged, or the row was scored before confidence was recorded.
|
|
1390
1398
|
*/
|
|
@@ -1668,7 +1676,7 @@ type Person = {
|
|
|
1668
1676
|
tags: Array<string>;
|
|
1669
1677
|
notes: string;
|
|
1670
1678
|
/**
|
|
1671
|
-
* Their posts stay out of the feed and every channel; ingest and billing are untouched.
|
|
1679
|
+
* Their posts stay out of the feed and every channel; ingest and billing are untouched. Read with groupId it is that group's own mute, which hides them from the mentions of that group's keywords only.
|
|
1672
1680
|
*/
|
|
1673
1681
|
muted: boolean;
|
|
1674
1682
|
};
|
|
@@ -1913,11 +1921,23 @@ type FilterGroup = {
|
|
|
1913
1921
|
*/
|
|
1914
1922
|
notLanguages?: Array<string>;
|
|
1915
1923
|
/**
|
|
1916
|
-
* Only
|
|
1924
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
1925
|
+
*/
|
|
1926
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
1927
|
+
/**
|
|
1928
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
1929
|
+
*/
|
|
1930
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
1931
|
+
/**
|
|
1932
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
1933
|
+
*/
|
|
1934
|
+
organization?: boolean;
|
|
1935
|
+
/**
|
|
1936
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
1917
1937
|
*/
|
|
1918
1938
|
tags?: Array<string>;
|
|
1919
1939
|
/**
|
|
1920
|
-
* Never authors tagged with any of these.
|
|
1940
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
1921
1941
|
*/
|
|
1922
1942
|
notTags?: Array<string>;
|
|
1923
1943
|
/**
|
|
@@ -2074,11 +2094,23 @@ type View = {
|
|
|
2074
2094
|
*/
|
|
2075
2095
|
notLanguages?: Array<string>;
|
|
2076
2096
|
/**
|
|
2077
|
-
* Only
|
|
2097
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
2098
|
+
*/
|
|
2099
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
2100
|
+
/**
|
|
2101
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
2102
|
+
*/
|
|
2103
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
2104
|
+
/**
|
|
2105
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
2106
|
+
*/
|
|
2107
|
+
organization?: boolean;
|
|
2108
|
+
/**
|
|
2109
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
2078
2110
|
*/
|
|
2079
2111
|
tags?: Array<string>;
|
|
2080
2112
|
/**
|
|
2081
|
-
* Never authors tagged with any of these.
|
|
2113
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
2082
2114
|
*/
|
|
2083
2115
|
notTags?: Array<string>;
|
|
2084
2116
|
/**
|
|
@@ -3130,7 +3162,7 @@ type Alert = {
|
|
|
3130
3162
|
*/
|
|
3131
3163
|
minFollowers?: number;
|
|
3132
3164
|
/**
|
|
3133
|
-
* Only authors
|
|
3165
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
3134
3166
|
*/
|
|
3135
3167
|
tags?: Array<string>;
|
|
3136
3168
|
/**
|
|
@@ -3141,10 +3173,22 @@ type Alert = {
|
|
|
3141
3173
|
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
3142
3174
|
*/
|
|
3143
3175
|
languages?: Array<string>;
|
|
3176
|
+
/**
|
|
3177
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). A post whose country is unknown never passes.
|
|
3178
|
+
*/
|
|
3179
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
3180
|
+
/**
|
|
3181
|
+
* Never posts whose author is in these countries: ["in"]. A post whose country is unknown still passes.
|
|
3182
|
+
*/
|
|
3183
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
3144
3184
|
/**
|
|
3145
3185
|
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
3146
3186
|
*/
|
|
3147
3187
|
automated?: boolean;
|
|
3188
|
+
/**
|
|
3189
|
+
* true: only posts by companies, brands and organizations; false: only posts by people. Omit for both.
|
|
3190
|
+
*/
|
|
3191
|
+
organization?: boolean;
|
|
3148
3192
|
/**
|
|
3149
3193
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
3150
3194
|
*/
|
|
@@ -3611,7 +3655,7 @@ type AnalyticsBreakdown = {
|
|
|
3611
3655
|
/**
|
|
3612
3656
|
* The dimension the rows are grouped by.
|
|
3613
3657
|
*/
|
|
3614
|
-
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'subreddit';
|
|
3658
|
+
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit';
|
|
3615
3659
|
/**
|
|
3616
3660
|
* Most matched first, at most 50 groups. by=hour is chronological and unlimited (168 cells at most).
|
|
3617
3661
|
*/
|
|
@@ -5269,12 +5313,16 @@ type SearchMentionsData = {
|
|
|
5269
5313
|
* 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.
|
|
5270
5314
|
*/
|
|
5271
5315
|
automated?: boolean;
|
|
5316
|
+
/**
|
|
5317
|
+
* true: only posts by companies, brands and organizations (a LinkedIn company page, a GitHub organization, a business account); false: only posts by people, mentions judged before this existed included. Omitted: everything.
|
|
5318
|
+
*/
|
|
5319
|
+
organization?: boolean;
|
|
5272
5320
|
/**
|
|
5273
5321
|
* Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
|
|
5274
5322
|
*/
|
|
5275
5323
|
personId?: string;
|
|
5276
5324
|
/**
|
|
5277
|
-
* true: include mentions by people you muted, hidden by default.
|
|
5325
|
+
* true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
|
|
5278
5326
|
*/
|
|
5279
5327
|
includeMuted?: boolean;
|
|
5280
5328
|
/**
|
|
@@ -5330,7 +5378,7 @@ type SearchMentionsData = {
|
|
|
5330
5378
|
*/
|
|
5331
5379
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
5332
5380
|
/**
|
|
5333
|
-
* Only authors
|
|
5381
|
+
* Only authors tagged with any of these (exact, case-sensitive), in the workspace's tags or those of the mention's own keyword group. Repeatable, or comma-separated.
|
|
5334
5382
|
*/
|
|
5335
5383
|
tags?: Array<string> | null;
|
|
5336
5384
|
/**
|
|
@@ -5390,7 +5438,7 @@ type SearchMentionsData = {
|
|
|
5390
5438
|
*/
|
|
5391
5439
|
notSubreddits?: Array<string> | null;
|
|
5392
5440
|
/**
|
|
5393
|
-
* Never authors
|
|
5441
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
5394
5442
|
*/
|
|
5395
5443
|
notTags?: Array<string> | null;
|
|
5396
5444
|
/**
|
|
@@ -5401,6 +5449,14 @@ type SearchMentionsData = {
|
|
|
5401
5449
|
* Never posts in these languages. A post whose language is unknown still passes.
|
|
5402
5450
|
*/
|
|
5403
5451
|
notLanguages?: Array<string>;
|
|
5452
|
+
/**
|
|
5453
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de), as the classifier read the author's profile and the post. A post whose country is unknown never passes.
|
|
5454
|
+
*/
|
|
5455
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
5456
|
+
/**
|
|
5457
|
+
* Never posts whose author is in these countries: notCountries=in. A post whose country is unknown still passes.
|
|
5458
|
+
*/
|
|
5459
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
5404
5460
|
/**
|
|
5405
5461
|
* 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.
|
|
5406
5462
|
*/
|
|
@@ -5520,12 +5576,16 @@ type ExportMentionsCsvData = {
|
|
|
5520
5576
|
* 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.
|
|
5521
5577
|
*/
|
|
5522
5578
|
automated?: boolean;
|
|
5579
|
+
/**
|
|
5580
|
+
* true: only posts by companies, brands and organizations (a LinkedIn company page, a GitHub organization, a business account); false: only posts by people, mentions judged before this existed included. Omitted: everything.
|
|
5581
|
+
*/
|
|
5582
|
+
organization?: boolean;
|
|
5523
5583
|
/**
|
|
5524
5584
|
* Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
|
|
5525
5585
|
*/
|
|
5526
5586
|
personId?: string;
|
|
5527
5587
|
/**
|
|
5528
|
-
* true: include mentions by people you muted, hidden by default.
|
|
5588
|
+
* true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
|
|
5529
5589
|
*/
|
|
5530
5590
|
includeMuted?: boolean;
|
|
5531
5591
|
/**
|
|
@@ -5581,7 +5641,7 @@ type ExportMentionsCsvData = {
|
|
|
5581
5641
|
*/
|
|
5582
5642
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
5583
5643
|
/**
|
|
5584
|
-
* Only authors
|
|
5644
|
+
* Only authors tagged with any of these (exact, case-sensitive), in the workspace's tags or those of the mention's own keyword group. Repeatable, or comma-separated.
|
|
5585
5645
|
*/
|
|
5586
5646
|
tags?: Array<string> | null;
|
|
5587
5647
|
/**
|
|
@@ -5641,7 +5701,7 @@ type ExportMentionsCsvData = {
|
|
|
5641
5701
|
*/
|
|
5642
5702
|
notSubreddits?: Array<string> | null;
|
|
5643
5703
|
/**
|
|
5644
|
-
* Never authors
|
|
5704
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
5645
5705
|
*/
|
|
5646
5706
|
notTags?: Array<string> | null;
|
|
5647
5707
|
/**
|
|
@@ -5652,6 +5712,14 @@ type ExportMentionsCsvData = {
|
|
|
5652
5712
|
* Never posts in these languages. A post whose language is unknown still passes.
|
|
5653
5713
|
*/
|
|
5654
5714
|
notLanguages?: Array<string>;
|
|
5715
|
+
/**
|
|
5716
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de), as the classifier read the author's profile and the post. A post whose country is unknown never passes.
|
|
5717
|
+
*/
|
|
5718
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
5719
|
+
/**
|
|
5720
|
+
* Never posts whose author is in these countries: notCountries=in. A post whose country is unknown still passes.
|
|
5721
|
+
*/
|
|
5722
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
5655
5723
|
/**
|
|
5656
5724
|
* 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.
|
|
5657
5725
|
*/
|
|
@@ -5805,12 +5873,16 @@ type ExportMentionsJsonData = {
|
|
|
5805
5873
|
* 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.
|
|
5806
5874
|
*/
|
|
5807
5875
|
automated?: boolean;
|
|
5876
|
+
/**
|
|
5877
|
+
* true: only posts by companies, brands and organizations (a LinkedIn company page, a GitHub organization, a business account); false: only posts by people, mentions judged before this existed included. Omitted: everything.
|
|
5878
|
+
*/
|
|
5879
|
+
organization?: boolean;
|
|
5808
5880
|
/**
|
|
5809
5881
|
* Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
|
|
5810
5882
|
*/
|
|
5811
5883
|
personId?: string;
|
|
5812
5884
|
/**
|
|
5813
|
-
* true: include mentions by people you muted, hidden by default.
|
|
5885
|
+
* true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
|
|
5814
5886
|
*/
|
|
5815
5887
|
includeMuted?: boolean;
|
|
5816
5888
|
/**
|
|
@@ -5866,7 +5938,7 @@ type ExportMentionsJsonData = {
|
|
|
5866
5938
|
*/
|
|
5867
5939
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
5868
5940
|
/**
|
|
5869
|
-
* Only authors
|
|
5941
|
+
* Only authors tagged with any of these (exact, case-sensitive), in the workspace's tags or those of the mention's own keyword group. Repeatable, or comma-separated.
|
|
5870
5942
|
*/
|
|
5871
5943
|
tags?: Array<string> | null;
|
|
5872
5944
|
/**
|
|
@@ -5926,7 +5998,7 @@ type ExportMentionsJsonData = {
|
|
|
5926
5998
|
*/
|
|
5927
5999
|
notSubreddits?: Array<string> | null;
|
|
5928
6000
|
/**
|
|
5929
|
-
* Never authors
|
|
6001
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
5930
6002
|
*/
|
|
5931
6003
|
notTags?: Array<string> | null;
|
|
5932
6004
|
/**
|
|
@@ -5937,6 +6009,14 @@ type ExportMentionsJsonData = {
|
|
|
5937
6009
|
* Never posts in these languages. A post whose language is unknown still passes.
|
|
5938
6010
|
*/
|
|
5939
6011
|
notLanguages?: Array<string>;
|
|
6012
|
+
/**
|
|
6013
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de), as the classifier read the author's profile and the post. A post whose country is unknown never passes.
|
|
6014
|
+
*/
|
|
6015
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
6016
|
+
/**
|
|
6017
|
+
* Never posts whose author is in these countries: notCountries=in. A post whose country is unknown still passes.
|
|
6018
|
+
*/
|
|
6019
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
5940
6020
|
/**
|
|
5941
6021
|
* 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.
|
|
5942
6022
|
*/
|
|
@@ -6024,7 +6104,7 @@ type ExportPeopleCsvData = {
|
|
|
6024
6104
|
path?: never;
|
|
6025
6105
|
query?: {
|
|
6026
6106
|
/**
|
|
6027
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6107
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6028
6108
|
*/
|
|
6029
6109
|
groupId?: string;
|
|
6030
6110
|
/**
|
|
@@ -6161,7 +6241,7 @@ type ListPeopleData = {
|
|
|
6161
6241
|
path?: never;
|
|
6162
6242
|
query?: {
|
|
6163
6243
|
/**
|
|
6164
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6244
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6165
6245
|
*/
|
|
6166
6246
|
groupId?: string;
|
|
6167
6247
|
/**
|
|
@@ -6407,7 +6487,7 @@ type ListPeopleResponses = {
|
|
|
6407
6487
|
tags: Array<string>;
|
|
6408
6488
|
notes: string;
|
|
6409
6489
|
/**
|
|
6410
|
-
* Their posts stay out of the feed and every channel; ingest and billing are untouched.
|
|
6490
|
+
* Their posts stay out of the feed and every channel; ingest and billing are untouched. Read with groupId it is that group's own mute, which hides them from the mentions of that group's keywords only.
|
|
6411
6491
|
*/
|
|
6412
6492
|
muted: boolean;
|
|
6413
6493
|
};
|
|
@@ -6453,7 +6533,7 @@ type GetPersonData = {
|
|
|
6453
6533
|
};
|
|
6454
6534
|
query?: {
|
|
6455
6535
|
/**
|
|
6456
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6536
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6457
6537
|
*/
|
|
6458
6538
|
groupId?: string;
|
|
6459
6539
|
};
|
|
@@ -6487,6 +6567,9 @@ type UpdatePersonData = {
|
|
|
6487
6567
|
*/
|
|
6488
6568
|
tags?: Array<string>;
|
|
6489
6569
|
notes?: string;
|
|
6570
|
+
/**
|
|
6571
|
+
* true hides their posts from the feed, the alerts and the digests; false shows them again. Without groupId, for every keyword of the workspace; with groupId, for the mentions of that group's keywords only, leaving the workspace's mute as it is.
|
|
6572
|
+
*/
|
|
6490
6573
|
muted?: boolean;
|
|
6491
6574
|
/**
|
|
6492
6575
|
* The member who owns the contact (user id); null clears.
|
|
@@ -6505,7 +6588,7 @@ type UpdatePersonData = {
|
|
|
6505
6588
|
};
|
|
6506
6589
|
query?: {
|
|
6507
6590
|
/**
|
|
6508
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6591
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6509
6592
|
*/
|
|
6510
6593
|
groupId?: string;
|
|
6511
6594
|
};
|
|
@@ -6513,7 +6596,7 @@ type UpdatePersonData = {
|
|
|
6513
6596
|
};
|
|
6514
6597
|
type UpdatePersonErrors = {
|
|
6515
6598
|
/**
|
|
6516
|
-
* Invalid body, the owner is not a workspace member
|
|
6599
|
+
* Invalid body, or the owner is not a workspace member
|
|
6517
6600
|
*/
|
|
6518
6601
|
400: ErrorResponse;
|
|
6519
6602
|
/**
|
|
@@ -6548,7 +6631,7 @@ type MergePeopleData = {
|
|
|
6548
6631
|
};
|
|
6549
6632
|
query?: {
|
|
6550
6633
|
/**
|
|
6551
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6634
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6552
6635
|
*/
|
|
6553
6636
|
groupId?: string;
|
|
6554
6637
|
};
|
|
@@ -6582,7 +6665,7 @@ type SplitPersonData = {
|
|
|
6582
6665
|
};
|
|
6583
6666
|
query?: {
|
|
6584
6667
|
/**
|
|
6585
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6668
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6586
6669
|
*/
|
|
6587
6670
|
groupId?: string;
|
|
6588
6671
|
};
|
|
@@ -6616,7 +6699,7 @@ type ListPersonActivitiesData = {
|
|
|
6616
6699
|
};
|
|
6617
6700
|
query?: {
|
|
6618
6701
|
/**
|
|
6619
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6702
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6620
6703
|
*/
|
|
6621
6704
|
groupId?: string;
|
|
6622
6705
|
};
|
|
@@ -6708,7 +6791,7 @@ type LogPersonActivityData = {
|
|
|
6708
6791
|
};
|
|
6709
6792
|
query?: {
|
|
6710
6793
|
/**
|
|
6711
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6794
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6712
6795
|
*/
|
|
6713
6796
|
groupId?: string;
|
|
6714
6797
|
};
|
|
@@ -6750,7 +6833,7 @@ type DeletePersonActivityData = {
|
|
|
6750
6833
|
};
|
|
6751
6834
|
query?: {
|
|
6752
6835
|
/**
|
|
6753
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6836
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6754
6837
|
*/
|
|
6755
6838
|
groupId?: string;
|
|
6756
6839
|
};
|
|
@@ -6779,7 +6862,7 @@ type ListSegmentsData = {
|
|
|
6779
6862
|
path?: never;
|
|
6780
6863
|
query?: {
|
|
6781
6864
|
/**
|
|
6782
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
6865
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
6783
6866
|
*/
|
|
6784
6867
|
groupId?: string;
|
|
6785
6868
|
};
|
|
@@ -7066,7 +7149,7 @@ type CreateSegmentData = {
|
|
|
7066
7149
|
path?: never;
|
|
7067
7150
|
query?: {
|
|
7068
7151
|
/**
|
|
7069
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
7152
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
7070
7153
|
*/
|
|
7071
7154
|
groupId?: string;
|
|
7072
7155
|
};
|
|
@@ -7108,7 +7191,7 @@ type DeleteSegmentData = {
|
|
|
7108
7191
|
};
|
|
7109
7192
|
query?: {
|
|
7110
7193
|
/**
|
|
7111
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
7194
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
7112
7195
|
*/
|
|
7113
7196
|
groupId?: string;
|
|
7114
7197
|
};
|
|
@@ -7142,7 +7225,7 @@ type GetSegmentData = {
|
|
|
7142
7225
|
};
|
|
7143
7226
|
query?: {
|
|
7144
7227
|
/**
|
|
7145
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
7228
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
7146
7229
|
*/
|
|
7147
7230
|
groupId?: string;
|
|
7148
7231
|
};
|
|
@@ -7259,7 +7342,7 @@ type UpdateSegmentData = {
|
|
|
7259
7342
|
};
|
|
7260
7343
|
query?: {
|
|
7261
7344
|
/**
|
|
7262
|
-
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, merges, activities and segments. Omit for the whole workspace.
|
|
7345
|
+
* Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
|
|
7263
7346
|
*/
|
|
7264
7347
|
groupId?: string;
|
|
7265
7348
|
};
|
|
@@ -7393,11 +7476,23 @@ type ListViewsResponses = {
|
|
|
7393
7476
|
*/
|
|
7394
7477
|
notLanguages?: Array<string>;
|
|
7395
7478
|
/**
|
|
7396
|
-
* Only
|
|
7479
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
7480
|
+
*/
|
|
7481
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
7482
|
+
/**
|
|
7483
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
7484
|
+
*/
|
|
7485
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
7486
|
+
/**
|
|
7487
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
7488
|
+
*/
|
|
7489
|
+
organization?: boolean;
|
|
7490
|
+
/**
|
|
7491
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
7397
7492
|
*/
|
|
7398
7493
|
tags?: Array<string>;
|
|
7399
7494
|
/**
|
|
7400
|
-
* Never authors tagged with any of these.
|
|
7495
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
7401
7496
|
*/
|
|
7402
7497
|
notTags?: Array<string>;
|
|
7403
7498
|
/**
|
|
@@ -7576,11 +7671,23 @@ type CreateViewData = {
|
|
|
7576
7671
|
*/
|
|
7577
7672
|
notLanguages?: Array<string>;
|
|
7578
7673
|
/**
|
|
7579
|
-
* Only
|
|
7674
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
7675
|
+
*/
|
|
7676
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
7677
|
+
/**
|
|
7678
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
7679
|
+
*/
|
|
7680
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
7681
|
+
/**
|
|
7682
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
7683
|
+
*/
|
|
7684
|
+
organization?: boolean;
|
|
7685
|
+
/**
|
|
7686
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
7580
7687
|
*/
|
|
7581
7688
|
tags?: Array<string>;
|
|
7582
7689
|
/**
|
|
7583
|
-
* Never authors tagged with any of these.
|
|
7690
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
7584
7691
|
*/
|
|
7585
7692
|
notTags?: Array<string>;
|
|
7586
7693
|
/**
|
|
@@ -7826,11 +7933,23 @@ type UpdateViewData = {
|
|
|
7826
7933
|
*/
|
|
7827
7934
|
notLanguages?: Array<string>;
|
|
7828
7935
|
/**
|
|
7829
|
-
* Only
|
|
7936
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
7937
|
+
*/
|
|
7938
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
7939
|
+
/**
|
|
7940
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
7941
|
+
*/
|
|
7942
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
7943
|
+
/**
|
|
7944
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
7945
|
+
*/
|
|
7946
|
+
organization?: boolean;
|
|
7947
|
+
/**
|
|
7948
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
7830
7949
|
*/
|
|
7831
7950
|
tags?: Array<string>;
|
|
7832
7951
|
/**
|
|
7833
|
-
* Never authors tagged with any of these.
|
|
7952
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
7834
7953
|
*/
|
|
7835
7954
|
notTags?: Array<string>;
|
|
7836
7955
|
/**
|
|
@@ -8976,7 +9095,7 @@ type UpdateAlertData = {
|
|
|
8976
9095
|
*/
|
|
8977
9096
|
minFollowers?: number;
|
|
8978
9097
|
/**
|
|
8979
|
-
* Only authors
|
|
9098
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
8980
9099
|
*/
|
|
8981
9100
|
tags?: Array<string>;
|
|
8982
9101
|
/**
|
|
@@ -8987,10 +9106,22 @@ type UpdateAlertData = {
|
|
|
8987
9106
|
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
8988
9107
|
*/
|
|
8989
9108
|
languages?: Array<string>;
|
|
9109
|
+
/**
|
|
9110
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). A post whose country is unknown never passes.
|
|
9111
|
+
*/
|
|
9112
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
9113
|
+
/**
|
|
9114
|
+
* Never posts whose author is in these countries: ["in"]. A post whose country is unknown still passes.
|
|
9115
|
+
*/
|
|
9116
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
8990
9117
|
/**
|
|
8991
9118
|
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
8992
9119
|
*/
|
|
8993
9120
|
automated?: boolean;
|
|
9121
|
+
/**
|
|
9122
|
+
* true: only posts by companies, brands and organizations; false: only posts by people. Omit for both.
|
|
9123
|
+
*/
|
|
9124
|
+
organization?: boolean;
|
|
8994
9125
|
/**
|
|
8995
9126
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
8996
9127
|
*/
|
|
@@ -9145,7 +9276,7 @@ type ListAlertsResponses = {
|
|
|
9145
9276
|
*/
|
|
9146
9277
|
minFollowers?: number;
|
|
9147
9278
|
/**
|
|
9148
|
-
* Only authors
|
|
9279
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
9149
9280
|
*/
|
|
9150
9281
|
tags?: Array<string>;
|
|
9151
9282
|
/**
|
|
@@ -9156,10 +9287,22 @@ type ListAlertsResponses = {
|
|
|
9156
9287
|
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
9157
9288
|
*/
|
|
9158
9289
|
languages?: Array<string>;
|
|
9290
|
+
/**
|
|
9291
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). A post whose country is unknown never passes.
|
|
9292
|
+
*/
|
|
9293
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
9294
|
+
/**
|
|
9295
|
+
* Never posts whose author is in these countries: ["in"]. A post whose country is unknown still passes.
|
|
9296
|
+
*/
|
|
9297
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
9159
9298
|
/**
|
|
9160
9299
|
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
9161
9300
|
*/
|
|
9162
9301
|
automated?: boolean;
|
|
9302
|
+
/**
|
|
9303
|
+
* true: only posts by companies, brands and organizations; false: only posts by people. Omit for both.
|
|
9304
|
+
*/
|
|
9305
|
+
organization?: boolean;
|
|
9163
9306
|
/**
|
|
9164
9307
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
9165
9308
|
*/
|
|
@@ -9290,7 +9433,7 @@ type CreateAlertData = {
|
|
|
9290
9433
|
*/
|
|
9291
9434
|
minFollowers?: number;
|
|
9292
9435
|
/**
|
|
9293
|
-
* Only authors
|
|
9436
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
9294
9437
|
*/
|
|
9295
9438
|
tags?: Array<string>;
|
|
9296
9439
|
/**
|
|
@@ -9301,10 +9444,22 @@ type CreateAlertData = {
|
|
|
9301
9444
|
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
9302
9445
|
*/
|
|
9303
9446
|
languages?: Array<string>;
|
|
9447
|
+
/**
|
|
9448
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). A post whose country is unknown never passes.
|
|
9449
|
+
*/
|
|
9450
|
+
countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
9451
|
+
/**
|
|
9452
|
+
* Never posts whose author is in these countries: ["in"]. A post whose country is unknown still passes.
|
|
9453
|
+
*/
|
|
9454
|
+
notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
|
|
9304
9455
|
/**
|
|
9305
9456
|
* true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
|
|
9306
9457
|
*/
|
|
9307
9458
|
automated?: boolean;
|
|
9459
|
+
/**
|
|
9460
|
+
* true: only posts by companies, brands and organizations; false: only posts by people. Omit for both.
|
|
9461
|
+
*/
|
|
9462
|
+
organization?: boolean;
|
|
9308
9463
|
/**
|
|
9309
9464
|
* Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.
|
|
9310
9465
|
*/
|
|
@@ -9691,9 +9846,9 @@ type GetAnalyticsBreakdownData = {
|
|
|
9691
9846
|
*/
|
|
9692
9847
|
timezone?: string;
|
|
9693
9848
|
/**
|
|
9694
|
-
* The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one), subreddit (Reddit posts only, most active first; `share` stays a percent of the whole window, every platform included).
|
|
9849
|
+
* The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one), country (where the author is, ISO 3166-1 alpha-2; "unknown" for posts without one), subreddit (Reddit posts only, most active first; `share` stays a percent of the whole window, every platform included).
|
|
9695
9850
|
*/
|
|
9696
|
-
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'subreddit';
|
|
9851
|
+
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit';
|
|
9697
9852
|
};
|
|
9698
9853
|
url: '/v1/analytics/breakdown';
|
|
9699
9854
|
};
|
|
@@ -10217,7 +10372,7 @@ declare const searchMentions: <ThrowOnError extends boolean = false>(options?: O
|
|
|
10217
10372
|
/**
|
|
10218
10373
|
* Export mentions as CSV
|
|
10219
10374
|
*
|
|
10220
|
-
* The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them), duplicate_of (the mention a cross-post copies; the CSV keeps one row per mention, copies included, so it adds up to the bill), kind (post, comment or repository), parent_url (the post a comment answers), comments (comments of it delivered to you), subreddit and flair (Reddit only). 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.
|
|
10375
|
+
* The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them), duplicate_of (the mention a cross-post copies; the CSV keeps one row per mention, copies included, so it adds up to the bill), kind (post, comment or repository), parent_url (the post a comment answers), comments (comments of it delivered to you), subreddit and flair (Reddit only), country (where the author is, ISO 3166-1 alpha-2, empty when unknown) and organization (true when a company or organization posted). Capped at 10,000 rows; the X-Mentions-Truncated header says when the cap cut the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
|
|
10221
10376
|
*/
|
|
10222
10377
|
declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
|
|
10223
10378
|
/**
|
|
@@ -10247,43 +10402,43 @@ declare const listPeople: <ThrowOnError extends boolean = false>(options?: Optio
|
|
|
10247
10402
|
/**
|
|
10248
10403
|
* Get a person
|
|
10249
10404
|
*
|
|
10250
|
-
* One person as your workspace sees them. An account merged into someone resolves to that person. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, merges and activities, apart from the workspace's and from every other group's.
|
|
10405
|
+
* One person as your workspace sees them. An account merged into someone resolves to that person. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
|
|
10251
10406
|
*/
|
|
10252
10407
|
declare const getPerson: <ThrowOnError extends boolean = false>(options: Options<GetPersonData, ThrowOnError>) => RequestResult<GetPersonResponses, GetPersonErrors, ThrowOnError>;
|
|
10253
10408
|
/**
|
|
10254
10409
|
* Update your annotations on a person
|
|
10255
10410
|
*
|
|
10256
|
-
* Tags, notes, mute, and the outreach owner (a workspace member; null clears) and stage, for your workspace only. Mute hides their posts from your feed and every channel; ingest and billing never change. With `groupId` the annotations are that keyword group's own
|
|
10411
|
+
* Tags, notes, mute, and the outreach owner (a workspace member; null clears) and stage, for your workspace only. Mute hides their posts from your feed and every channel; ingest and billing never change. With `groupId` the annotations are that keyword group's own: `muted` hides the person, and the accounts that group merged into them, from the mentions of that group's keywords only (feed, alerts and digests), and the group's tags show on those mentions next to the workspace's. A mute set without `groupId` hides them everywhere.
|
|
10257
10412
|
*/
|
|
10258
10413
|
declare const updatePerson: <ThrowOnError extends boolean = false>(options: Options<UpdatePersonData, ThrowOnError>) => RequestResult<UpdatePersonResponses, UpdatePersonErrors, ThrowOnError>;
|
|
10259
10414
|
/**
|
|
10260
10415
|
* Merge an account into a person
|
|
10261
10416
|
*
|
|
10262
|
-
* Declare that this account and another person are the same human, for your workspace only. Their mentions, tags, notes and outreach activities combine under the person named by `into`, which keeps its owner and stage unless it had none. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, merges and activities, apart from the workspace's and from every other group's.
|
|
10417
|
+
* Declare that this account and another person are the same human, for your workspace only. Their mentions, tags, notes and outreach activities combine under the person named by `into`, which keeps its owner and stage unless it had none. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
|
|
10263
10418
|
*/
|
|
10264
10419
|
declare const mergePeople: <ThrowOnError extends boolean = false>(options: Options<MergePeopleData, ThrowOnError>) => RequestResult<MergePeopleResponses, MergePeopleErrors, ThrowOnError>;
|
|
10265
10420
|
/**
|
|
10266
10421
|
* Undo a merge
|
|
10267
10422
|
*
|
|
10268
|
-
* The account becomes its own person again. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, merges and activities, apart from the workspace's and from every other group's.
|
|
10423
|
+
* The account becomes its own person again. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
|
|
10269
10424
|
*/
|
|
10270
10425
|
declare const splitPerson: <ThrowOnError extends boolean = false>(options: Options<SplitPersonData, ThrowOnError>) => RequestResult<SplitPersonResponses, SplitPersonErrors, ThrowOnError>;
|
|
10271
10426
|
/**
|
|
10272
10427
|
* List outreach activities
|
|
10273
10428
|
*
|
|
10274
|
-
* Every logged contact with this person across all their accounts, newest first (at most 200): who reached out, the channel, when, and a short note. Read it before reaching out so two teammates never contact the same person without knowing. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, merges and activities, apart from the workspace's and from every other group's.
|
|
10429
|
+
* Every logged contact with this person across all their accounts, newest first (at most 200): who reached out, the channel, when, and a short note. Read it before reaching out so two teammates never contact the same person without knowing. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
|
|
10275
10430
|
*/
|
|
10276
10431
|
declare const listPersonActivities: <ThrowOnError extends boolean = false>(options: Options<ListPersonActivitiesData, ThrowOnError>) => RequestResult<ListPersonActivitiesResponses, ListPersonActivitiesErrors, ThrowOnError>;
|
|
10277
10432
|
/**
|
|
10278
10433
|
* Log an outreach activity
|
|
10279
10434
|
*
|
|
10280
|
-
* Record that a teammate reached out to this person: an email, a DM, a call. The first activity claims an unowned person for whoever reached out and moves not_contacted to contacted; an existing owner and a later stage are kept. `memberId` defaults to the signed-in member; an API key that omits it logs an unattributed activity, which claims nobody. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, merges and activities, apart from the workspace's and from every other group's.
|
|
10435
|
+
* Record that a teammate reached out to this person: an email, a DM, a call. The first activity claims an unowned person for whoever reached out and moves not_contacted to contacted; an existing owner and a later stage are kept. `memberId` defaults to the signed-in member; an API key that omits it logs an unattributed activity, which claims nobody. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
|
|
10281
10436
|
*/
|
|
10282
10437
|
declare const logPersonActivity: <ThrowOnError extends boolean = false>(options: Options<LogPersonActivityData, ThrowOnError>) => RequestResult<LogPersonActivityResponses, LogPersonActivityErrors, ThrowOnError>;
|
|
10283
10438
|
/**
|
|
10284
10439
|
* Delete an outreach activity
|
|
10285
10440
|
*
|
|
10286
|
-
* Remove a contact logged by mistake. The person's owner and stage stay as they are. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, merges and activities, apart from the workspace's and from every other group's.
|
|
10441
|
+
* Remove a contact logged by mistake. The person's owner and stage stay as they are. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
|
|
10287
10442
|
*/
|
|
10288
10443
|
declare const deletePersonActivity: <ThrowOnError extends boolean = false>(options: Options<DeletePersonActivityData, ThrowOnError>) => RequestResult<DeletePersonActivityResponses, DeletePersonActivityErrors, ThrowOnError>;
|
|
10289
10444
|
/**
|