@mentio-dev/sdk 0.15.0 → 0.16.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 +2565 -342
- package/dist/index.js +61 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -396,7 +396,13 @@ type Keyword = {
|
|
|
396
396
|
* Keyword id (kw_...).
|
|
397
397
|
*/
|
|
398
398
|
id: string;
|
|
399
|
+
/**
|
|
400
|
+
* The tracked text, as typed.
|
|
401
|
+
*/
|
|
399
402
|
term: string;
|
|
403
|
+
/**
|
|
404
|
+
* brand (your own name), competitor, or topic.
|
|
405
|
+
*/
|
|
400
406
|
kind: 'brand' | 'competitor' | 'topic';
|
|
401
407
|
/**
|
|
402
408
|
* Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
|
|
@@ -709,7 +715,7 @@ type ErrorResponse = {
|
|
|
709
715
|
/**
|
|
710
716
|
* 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.
|
|
711
717
|
*/
|
|
712
|
-
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'idempotency_key_in_use' | 'idempotency_key_reused' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'hourly_email_unsupported' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'feed_unreadable' | 'feed_login_required' | 'feed_login_expired' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'filter_too_complex' | 'duplicate_view' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
718
|
+
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'idempotency_key_in_use' | 'idempotency_key_reused' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'hourly_email_unsupported' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'feed_unreadable' | 'feed_login_required' | 'feed_login_expired' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'filter_too_complex' | 'duplicate_view' | 'duplicate_automation' | 'automation_filter_unreadable' | 'automation_limit_reached' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
713
719
|
/**
|
|
714
720
|
* Human-readable detail; may change between releases.
|
|
715
721
|
*/
|
|
@@ -1310,6 +1316,20 @@ type WorkspaceFilters = {
|
|
|
1310
1316
|
*/
|
|
1311
1317
|
updatedAt: string | null;
|
|
1312
1318
|
};
|
|
1319
|
+
type MentionBatchResult = {
|
|
1320
|
+
/**
|
|
1321
|
+
* The ids changed, in the order sent. A pending mention given only a status is not changed: it is in pending alone.
|
|
1322
|
+
*/
|
|
1323
|
+
updated: Array<string>;
|
|
1324
|
+
/**
|
|
1325
|
+
* The ids this workspace has no mention by, in the order sent; nothing was done to them.
|
|
1326
|
+
*/
|
|
1327
|
+
notFound: Array<string>;
|
|
1328
|
+
/**
|
|
1329
|
+
* Of the updated ids, those still waiting for the classifier: they took the labels and the assignee, but their status stays until they are scored. Empty unless the update set a status.
|
|
1330
|
+
*/
|
|
1331
|
+
pending: Array<string>;
|
|
1332
|
+
};
|
|
1313
1333
|
type Mention = {
|
|
1314
1334
|
/**
|
|
1315
1335
|
* Mention id (mm_...): one post matched to one of your keywords. A post matching two keywords has two ids.
|
|
@@ -1353,6 +1373,9 @@ type Mention = {
|
|
|
1353
1373
|
*/
|
|
1354
1374
|
matchedIn: 'text' | 'speech';
|
|
1355
1375
|
};
|
|
1376
|
+
/**
|
|
1377
|
+
* The post: platform, text, link, publish time and engagement.
|
|
1378
|
+
*/
|
|
1356
1379
|
post: {
|
|
1357
1380
|
/**
|
|
1358
1381
|
* Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
|
|
@@ -1425,11 +1448,29 @@ type Mention = {
|
|
|
1425
1448
|
* Counts as the platform reported them at ingest, usually minutes after posting; a missing count is null. Null as a whole when a platform reports none, or before September 2026. X carries all six.
|
|
1426
1449
|
*/
|
|
1427
1450
|
engagement: {
|
|
1451
|
+
/**
|
|
1452
|
+
* Likes or upvotes when the post was ingested; null when the platform does not report them.
|
|
1453
|
+
*/
|
|
1428
1454
|
likes: number | null;
|
|
1455
|
+
/**
|
|
1456
|
+
* Reposts or shares when ingested; null when not reported.
|
|
1457
|
+
*/
|
|
1429
1458
|
reposts: number | null;
|
|
1459
|
+
/**
|
|
1460
|
+
* Replies or comments when ingested; null when not reported.
|
|
1461
|
+
*/
|
|
1430
1462
|
replies: number | null;
|
|
1463
|
+
/**
|
|
1464
|
+
* Quotes when ingested; null when not reported.
|
|
1465
|
+
*/
|
|
1431
1466
|
quotes: number | null;
|
|
1467
|
+
/**
|
|
1468
|
+
* Views when ingested; null when not reported.
|
|
1469
|
+
*/
|
|
1432
1470
|
views: number | null;
|
|
1471
|
+
/**
|
|
1472
|
+
* Bookmarks or saves when ingested; null when not reported.
|
|
1473
|
+
*/
|
|
1433
1474
|
bookmarks: number | null;
|
|
1434
1475
|
} | null;
|
|
1435
1476
|
/**
|
|
@@ -1550,7 +1591,7 @@ type Mention = {
|
|
|
1550
1591
|
*/
|
|
1551
1592
|
relevance: number | null;
|
|
1552
1593
|
/**
|
|
1553
|
-
*
|
|
1594
|
+
* positive, neutral or negative; null until classified.
|
|
1554
1595
|
*/
|
|
1555
1596
|
sentiment: 'positive' | 'neutral' | 'negative';
|
|
1556
1597
|
/**
|
|
@@ -1627,13 +1668,25 @@ type Mention = {
|
|
|
1627
1668
|
};
|
|
1628
1669
|
} | null;
|
|
1629
1670
|
} | null;
|
|
1671
|
+
/**
|
|
1672
|
+
* What your team did with it: status, assignee, snooze and notes.
|
|
1673
|
+
*/
|
|
1630
1674
|
triage: {
|
|
1631
1675
|
/**
|
|
1632
1676
|
* Workspace member this mention is assigned to; null when unassigned.
|
|
1633
1677
|
*/
|
|
1634
1678
|
assignee: {
|
|
1679
|
+
/**
|
|
1680
|
+
* User id.
|
|
1681
|
+
*/
|
|
1635
1682
|
id: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* Member name.
|
|
1685
|
+
*/
|
|
1636
1686
|
name: string | null;
|
|
1687
|
+
/**
|
|
1688
|
+
* Member email.
|
|
1689
|
+
*/
|
|
1637
1690
|
email: string | null;
|
|
1638
1691
|
} | null;
|
|
1639
1692
|
/**
|
|
@@ -1645,6 +1698,10 @@ type Mention = {
|
|
|
1645
1698
|
*/
|
|
1646
1699
|
note: string | null;
|
|
1647
1700
|
};
|
|
1701
|
+
/**
|
|
1702
|
+
* Your labels on this mention (hot-lead, replied...), alphabetical. Set them with PATCH, POST /v1/mentions/batch or an automation.
|
|
1703
|
+
*/
|
|
1704
|
+
labels: Array<string>;
|
|
1648
1705
|
/**
|
|
1649
1706
|
* On a cross-post (same author, text and keyword within three days), the original's id. Billed like any mention, listed only under its original, never alerted alone. null for an original. See [Cross-posts](/how-it-works#cross-posts).
|
|
1650
1707
|
*/
|
|
@@ -1726,11 +1783,29 @@ type MentionComment = {
|
|
|
1726
1783
|
* Counts as the platform reported them at ingest, usually minutes after posting; a missing count is null. Null as a whole when a platform reports none, or before September 2026. X carries all six.
|
|
1727
1784
|
*/
|
|
1728
1785
|
engagement: {
|
|
1786
|
+
/**
|
|
1787
|
+
* Likes or upvotes when the post was ingested; null when the platform does not report them.
|
|
1788
|
+
*/
|
|
1729
1789
|
likes: number | null;
|
|
1790
|
+
/**
|
|
1791
|
+
* Reposts or shares when ingested; null when not reported.
|
|
1792
|
+
*/
|
|
1730
1793
|
reposts: number | null;
|
|
1794
|
+
/**
|
|
1795
|
+
* Replies or comments when ingested; null when not reported.
|
|
1796
|
+
*/
|
|
1731
1797
|
replies: number | null;
|
|
1798
|
+
/**
|
|
1799
|
+
* Quotes when ingested; null when not reported.
|
|
1800
|
+
*/
|
|
1732
1801
|
quotes: number | null;
|
|
1802
|
+
/**
|
|
1803
|
+
* Views when ingested; null when not reported.
|
|
1804
|
+
*/
|
|
1733
1805
|
views: number | null;
|
|
1806
|
+
/**
|
|
1807
|
+
* Bookmarks or saves when ingested; null when not reported.
|
|
1808
|
+
*/
|
|
1734
1809
|
bookmarks: number | null;
|
|
1735
1810
|
} | null;
|
|
1736
1811
|
/**
|
|
@@ -1738,7 +1813,7 @@ type MentionComment = {
|
|
|
1738
1813
|
*/
|
|
1739
1814
|
classification: {
|
|
1740
1815
|
/**
|
|
1741
|
-
*
|
|
1816
|
+
* positive, neutral or negative; null until classified.
|
|
1742
1817
|
*/
|
|
1743
1818
|
sentiment: 'positive' | 'neutral' | 'negative';
|
|
1744
1819
|
/**
|
|
@@ -1772,6 +1847,9 @@ type Person = {
|
|
|
1772
1847
|
* Profile URL of the canonical account.
|
|
1773
1848
|
*/
|
|
1774
1849
|
url: string | null;
|
|
1850
|
+
/**
|
|
1851
|
+
* Profile picture URL.
|
|
1852
|
+
*/
|
|
1775
1853
|
avatarUrl: string | null;
|
|
1776
1854
|
/**
|
|
1777
1855
|
* Every account this workspace treats as this person, the canonical one first.
|
|
@@ -1802,17 +1880,38 @@ type Person = {
|
|
|
1802
1880
|
* Platform counts as of their newest post; null where the platform has no such number.
|
|
1803
1881
|
*/
|
|
1804
1882
|
reach: {
|
|
1883
|
+
/**
|
|
1884
|
+
* Followers when last seen; null when unknown.
|
|
1885
|
+
*/
|
|
1805
1886
|
followers: number | null;
|
|
1887
|
+
/**
|
|
1888
|
+
* Accounts they follow; null when unknown.
|
|
1889
|
+
*/
|
|
1806
1890
|
following: number | null;
|
|
1891
|
+
/**
|
|
1892
|
+
* Posts on the platform; null when unknown.
|
|
1893
|
+
*/
|
|
1807
1894
|
posts: number | null;
|
|
1808
1895
|
};
|
|
1809
1896
|
/**
|
|
1810
1897
|
* Public profile facts; null until looked up.
|
|
1811
1898
|
*/
|
|
1812
1899
|
profile: {
|
|
1900
|
+
/**
|
|
1901
|
+
* The profile's bio, as the platform shows it.
|
|
1902
|
+
*/
|
|
1813
1903
|
bio: string | null;
|
|
1904
|
+
/**
|
|
1905
|
+
* Company named on the profile.
|
|
1906
|
+
*/
|
|
1814
1907
|
company: string | null;
|
|
1908
|
+
/**
|
|
1909
|
+
* Location named on the profile.
|
|
1910
|
+
*/
|
|
1815
1911
|
location: string | null;
|
|
1912
|
+
/**
|
|
1913
|
+
* Website linked from the profile.
|
|
1914
|
+
*/
|
|
1816
1915
|
website: string | null;
|
|
1817
1916
|
/**
|
|
1818
1917
|
* Only when the person made it public on the platform.
|
|
@@ -1822,7 +1921,13 @@ type Person = {
|
|
|
1822
1921
|
* Other accounts the person lists on their profile.
|
|
1823
1922
|
*/
|
|
1824
1923
|
links: Array<{
|
|
1924
|
+
/**
|
|
1925
|
+
* The platform or kind of the linked account (github, x, website, ...).
|
|
1926
|
+
*/
|
|
1825
1927
|
provider: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* Link to the account.
|
|
1930
|
+
*/
|
|
1826
1931
|
url: string;
|
|
1827
1932
|
}>;
|
|
1828
1933
|
/**
|
|
@@ -1842,9 +1947,21 @@ type Person = {
|
|
|
1842
1947
|
* Of those, scored relevant.
|
|
1843
1948
|
*/
|
|
1844
1949
|
relevant: number;
|
|
1950
|
+
/**
|
|
1951
|
+
* Their matched mentions by sentiment.
|
|
1952
|
+
*/
|
|
1845
1953
|
sentiment: {
|
|
1954
|
+
/**
|
|
1955
|
+
* Scored positive.
|
|
1956
|
+
*/
|
|
1846
1957
|
positive: number;
|
|
1958
|
+
/**
|
|
1959
|
+
* Scored neutral.
|
|
1960
|
+
*/
|
|
1847
1961
|
neutral: number;
|
|
1962
|
+
/**
|
|
1963
|
+
* Scored negative.
|
|
1964
|
+
*/
|
|
1848
1965
|
negative: number;
|
|
1849
1966
|
};
|
|
1850
1967
|
/**
|
|
@@ -1860,7 +1977,13 @@ type Person = {
|
|
|
1860
1977
|
* What this workspace wrote about the person.
|
|
1861
1978
|
*/
|
|
1862
1979
|
annotations: {
|
|
1980
|
+
/**
|
|
1981
|
+
* Tags your team gave them.
|
|
1982
|
+
*/
|
|
1863
1983
|
tags: Array<string>;
|
|
1984
|
+
/**
|
|
1985
|
+
* Your team's notes.
|
|
1986
|
+
*/
|
|
1864
1987
|
notes: string;
|
|
1865
1988
|
/**
|
|
1866
1989
|
* 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.
|
|
@@ -1879,7 +2002,13 @@ type Person = {
|
|
|
1879
2002
|
* User id of the workspace member.
|
|
1880
2003
|
*/
|
|
1881
2004
|
id: string;
|
|
2005
|
+
/**
|
|
2006
|
+
* The member's name.
|
|
2007
|
+
*/
|
|
1882
2008
|
name: string | null;
|
|
2009
|
+
/**
|
|
2010
|
+
* The member's email.
|
|
2011
|
+
*/
|
|
1883
2012
|
email: string | null;
|
|
1884
2013
|
} | null;
|
|
1885
2014
|
/**
|
|
@@ -1917,7 +2046,13 @@ type PersonActivity = {
|
|
|
1917
2046
|
* User id of the workspace member.
|
|
1918
2047
|
*/
|
|
1919
2048
|
id: string;
|
|
2049
|
+
/**
|
|
2050
|
+
* The member's name.
|
|
2051
|
+
*/
|
|
1920
2052
|
name: string | null;
|
|
2053
|
+
/**
|
|
2054
|
+
* The member's email.
|
|
2055
|
+
*/
|
|
1921
2056
|
email: string | null;
|
|
1922
2057
|
} | null;
|
|
1923
2058
|
/**
|
|
@@ -2010,6 +2145,18 @@ type SegmentPreset = {
|
|
|
2010
2145
|
* People at any of these outreach stages.
|
|
2011
2146
|
*/
|
|
2012
2147
|
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
2148
|
+
/**
|
|
2149
|
+
* Nobody at these outreach stages.
|
|
2150
|
+
*/
|
|
2151
|
+
notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
2152
|
+
/**
|
|
2153
|
+
* Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
2154
|
+
*/
|
|
2155
|
+
notLinkHosts?: Array<string>;
|
|
2156
|
+
/**
|
|
2157
|
+
* Nobody owned by these members (user ids); "none" drops the people nobody owns.
|
|
2158
|
+
*/
|
|
2159
|
+
notOwnerIds?: Array<string>;
|
|
2013
2160
|
/**
|
|
2014
2161
|
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
|
|
2015
2162
|
*/
|
|
@@ -2025,8 +2172,17 @@ type Segment = {
|
|
|
2025
2172
|
* Segment id (seg_...).
|
|
2026
2173
|
*/
|
|
2027
2174
|
id: string;
|
|
2175
|
+
/**
|
|
2176
|
+
* Segment name.
|
|
2177
|
+
*/
|
|
2028
2178
|
name: string;
|
|
2179
|
+
/**
|
|
2180
|
+
* What the segment is for.
|
|
2181
|
+
*/
|
|
2029
2182
|
description: string;
|
|
2183
|
+
/**
|
|
2184
|
+
* The people filter it saves (the fields of GET /v1/people).
|
|
2185
|
+
*/
|
|
2030
2186
|
filter: {
|
|
2031
2187
|
/**
|
|
2032
2188
|
* People with an account on any of these platforms.
|
|
@@ -2092,6 +2248,18 @@ type Segment = {
|
|
|
2092
2248
|
* People at any of these outreach stages.
|
|
2093
2249
|
*/
|
|
2094
2250
|
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
2251
|
+
/**
|
|
2252
|
+
* Nobody at these outreach stages.
|
|
2253
|
+
*/
|
|
2254
|
+
notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
2255
|
+
/**
|
|
2256
|
+
* Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
2257
|
+
*/
|
|
2258
|
+
notLinkHosts?: Array<string>;
|
|
2259
|
+
/**
|
|
2260
|
+
* Nobody owned by these members (user ids); "none" drops the people nobody owns.
|
|
2261
|
+
*/
|
|
2262
|
+
notOwnerIds?: Array<string>;
|
|
2095
2263
|
/**
|
|
2096
2264
|
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
|
|
2097
2265
|
*/
|
|
@@ -2138,6 +2306,10 @@ type FilterGroup = {
|
|
|
2138
2306
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
2139
2307
|
*/
|
|
2140
2308
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
2309
|
+
/**
|
|
2310
|
+
* Never matches of keywords of these kinds.
|
|
2311
|
+
*/
|
|
2312
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
2141
2313
|
/**
|
|
2142
2314
|
* Only matches of keywords in any of these groups (grp_...).
|
|
2143
2315
|
*/
|
|
@@ -2218,6 +2390,14 @@ type FilterGroup = {
|
|
|
2218
2390
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
2219
2391
|
*/
|
|
2220
2392
|
notTags?: Array<string>;
|
|
2393
|
+
/**
|
|
2394
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
2395
|
+
*/
|
|
2396
|
+
labels?: Array<string>;
|
|
2397
|
+
/**
|
|
2398
|
+
* Never mentions carrying any of these labels.
|
|
2399
|
+
*/
|
|
2400
|
+
notLabels?: Array<string>;
|
|
2221
2401
|
/**
|
|
2222
2402
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
2223
2403
|
*/
|
|
@@ -2296,8 +2476,17 @@ type View = {
|
|
|
2296
2476
|
* View id (vw_...).
|
|
2297
2477
|
*/
|
|
2298
2478
|
id: string;
|
|
2479
|
+
/**
|
|
2480
|
+
* View name.
|
|
2481
|
+
*/
|
|
2299
2482
|
name: string;
|
|
2483
|
+
/**
|
|
2484
|
+
* What the view is for.
|
|
2485
|
+
*/
|
|
2300
2486
|
description: string;
|
|
2487
|
+
/**
|
|
2488
|
+
* The mentions filter it saves (the fields of GET /v1/mentions).
|
|
2489
|
+
*/
|
|
2301
2490
|
filter: {
|
|
2302
2491
|
/**
|
|
2303
2492
|
* Substring in the post text or the author's name.
|
|
@@ -2315,6 +2504,10 @@ type View = {
|
|
|
2315
2504
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
2316
2505
|
*/
|
|
2317
2506
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
2507
|
+
/**
|
|
2508
|
+
* Never matches of keywords of these kinds.
|
|
2509
|
+
*/
|
|
2510
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
2318
2511
|
/**
|
|
2319
2512
|
* Only matches of keywords in any of these groups (grp_...).
|
|
2320
2513
|
*/
|
|
@@ -2395,6 +2588,14 @@ type View = {
|
|
|
2395
2588
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
2396
2589
|
*/
|
|
2397
2590
|
notTags?: Array<string>;
|
|
2591
|
+
/**
|
|
2592
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
2593
|
+
*/
|
|
2594
|
+
labels?: Array<string>;
|
|
2595
|
+
/**
|
|
2596
|
+
* Never mentions carrying any of these labels.
|
|
2597
|
+
*/
|
|
2598
|
+
notLabels?: Array<string>;
|
|
2398
2599
|
/**
|
|
2399
2600
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
2400
2601
|
*/
|
|
@@ -2481,157 +2682,231 @@ type View = {
|
|
|
2481
2682
|
*/
|
|
2482
2683
|
updatedAt: string;
|
|
2483
2684
|
};
|
|
2484
|
-
type
|
|
2685
|
+
type Automation = {
|
|
2485
2686
|
/**
|
|
2486
|
-
*
|
|
2687
|
+
* Automation id (atm_...).
|
|
2487
2688
|
*/
|
|
2488
|
-
|
|
2689
|
+
id: string;
|
|
2489
2690
|
/**
|
|
2490
|
-
*
|
|
2691
|
+
* Automation name, unique in the workspace.
|
|
2491
2692
|
*/
|
|
2492
|
-
|
|
2693
|
+
name: string;
|
|
2493
2694
|
/**
|
|
2494
|
-
*
|
|
2695
|
+
* false: kept but not run.
|
|
2495
2696
|
*/
|
|
2496
|
-
|
|
2697
|
+
enabled: boolean;
|
|
2698
|
+
/**
|
|
2699
|
+
* Which mentions it acts on: the fields of GET /v1/mentions, like a view.
|
|
2700
|
+
*/
|
|
2701
|
+
filter: {
|
|
2497
2702
|
/**
|
|
2498
|
-
*
|
|
2703
|
+
* Substring in the post text or the author's name.
|
|
2499
2704
|
*/
|
|
2500
|
-
|
|
2705
|
+
q?: string;
|
|
2501
2706
|
/**
|
|
2502
|
-
*
|
|
2707
|
+
* Only matches of any of these keywords.
|
|
2503
2708
|
*/
|
|
2504
|
-
|
|
2709
|
+
keywordIds?: Array<string>;
|
|
2505
2710
|
/**
|
|
2506
|
-
*
|
|
2711
|
+
* Never matches of these keywords.
|
|
2507
2712
|
*/
|
|
2508
|
-
|
|
2713
|
+
notKeywordIds?: Array<string>;
|
|
2509
2714
|
/**
|
|
2510
|
-
*
|
|
2715
|
+
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
2511
2716
|
*/
|
|
2512
|
-
|
|
2717
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
2513
2718
|
/**
|
|
2514
|
-
*
|
|
2719
|
+
* Never matches of keywords of these kinds.
|
|
2515
2720
|
*/
|
|
2516
|
-
|
|
2517
|
-
};
|
|
2518
|
-
/**
|
|
2519
|
-
* The stretch of time the counts cover, by match time.
|
|
2520
|
-
*/
|
|
2521
|
-
window: {
|
|
2721
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
2522
2722
|
/**
|
|
2523
|
-
*
|
|
2723
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
2524
2724
|
*/
|
|
2525
|
-
|
|
2725
|
+
groupIds?: Array<string>;
|
|
2526
2726
|
/**
|
|
2527
|
-
*
|
|
2727
|
+
* Never matches of keywords in these groups.
|
|
2528
2728
|
*/
|
|
2529
|
-
|
|
2530
|
-
};
|
|
2531
|
-
/**
|
|
2532
|
-
* Fresh matches in the hour: posts published at most 6 hours before they matched. Look-backs and free reviews never count.
|
|
2533
|
-
*/
|
|
2534
|
-
matches: number;
|
|
2535
|
-
/**
|
|
2536
|
-
* Of those, scored relevant so far.
|
|
2537
|
-
*/
|
|
2538
|
-
relevant: number;
|
|
2539
|
-
/**
|
|
2540
|
-
* What the keyword usually gets.
|
|
2541
|
-
*/
|
|
2542
|
-
baseline: {
|
|
2729
|
+
notGroupIds?: Array<string>;
|
|
2543
2730
|
/**
|
|
2544
|
-
*
|
|
2731
|
+
* Only posts from any of these platforms.
|
|
2545
2732
|
*/
|
|
2546
|
-
|
|
2733
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2547
2734
|
/**
|
|
2548
|
-
*
|
|
2735
|
+
* Never posts from these platforms.
|
|
2549
2736
|
*/
|
|
2550
|
-
|
|
2737
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
2551
2738
|
/**
|
|
2552
|
-
*
|
|
2739
|
+
* Only mentions in this status: open, ignored, done.
|
|
2553
2740
|
*/
|
|
2554
|
-
|
|
2555
|
-
};
|
|
2556
|
-
};
|
|
2557
|
-
type NegativeSpikeEventData = {
|
|
2558
|
-
/**
|
|
2559
|
-
* The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
|
|
2560
|
-
*/
|
|
2561
|
-
attentionId: string;
|
|
2562
|
-
/**
|
|
2563
|
-
* Where to look in the dashboard.
|
|
2564
|
-
*/
|
|
2565
|
-
url: string;
|
|
2566
|
-
/**
|
|
2567
|
-
* The keyword the item is about.
|
|
2568
|
-
*/
|
|
2569
|
-
keyword: {
|
|
2741
|
+
status?: 'open' | 'ignored' | 'done';
|
|
2570
2742
|
/**
|
|
2571
|
-
*
|
|
2743
|
+
* true: only mentions the classifier scored relevant; false: only the rest.
|
|
2572
2744
|
*/
|
|
2573
|
-
|
|
2745
|
+
relevant?: boolean;
|
|
2574
2746
|
/**
|
|
2575
|
-
*
|
|
2747
|
+
* Only mentions scored at least this.
|
|
2576
2748
|
*/
|
|
2577
|
-
|
|
2749
|
+
minRelevance?: number;
|
|
2578
2750
|
/**
|
|
2579
|
-
*
|
|
2751
|
+
* Only mentions whose classifier confidence is at least this.
|
|
2580
2752
|
*/
|
|
2581
|
-
|
|
2753
|
+
minConfidence?: number;
|
|
2582
2754
|
/**
|
|
2583
|
-
*
|
|
2755
|
+
* Only these sentiments.
|
|
2584
2756
|
*/
|
|
2585
|
-
|
|
2757
|
+
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
2586
2758
|
/**
|
|
2587
|
-
*
|
|
2759
|
+
* Never these sentiments; an unscored mention still passes.
|
|
2588
2760
|
*/
|
|
2589
|
-
|
|
2590
|
-
};
|
|
2591
|
-
/**
|
|
2592
|
-
* The stretch of time the counts cover, by match time.
|
|
2593
|
-
*/
|
|
2594
|
-
window: {
|
|
2761
|
+
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
2595
2762
|
/**
|
|
2596
|
-
*
|
|
2763
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
2597
2764
|
*/
|
|
2598
|
-
|
|
2765
|
+
intents?: Array<string>;
|
|
2599
2766
|
/**
|
|
2600
|
-
*
|
|
2767
|
+
* Never mentions carrying these tags.
|
|
2601
2768
|
*/
|
|
2602
|
-
|
|
2603
|
-
};
|
|
2604
|
-
/**
|
|
2605
|
-
* Relevant matches scored negative in the window.
|
|
2606
|
-
*/
|
|
2607
|
-
negative: number;
|
|
2608
|
-
/**
|
|
2609
|
-
* Relevant matches in the window.
|
|
2610
|
-
*/
|
|
2611
|
-
relevant: number;
|
|
2612
|
-
/**
|
|
2613
|
-
* negative / relevant.
|
|
2614
|
-
*/
|
|
2615
|
-
share: number;
|
|
2616
|
-
/**
|
|
2617
|
-
* What the keyword usually reads.
|
|
2618
|
-
*/
|
|
2619
|
-
baseline: {
|
|
2769
|
+
notIntents?: Array<string>;
|
|
2620
2770
|
/**
|
|
2621
|
-
*
|
|
2771
|
+
* true: only posts that read as machine-made; false: only the rest.
|
|
2622
2772
|
*/
|
|
2623
|
-
|
|
2773
|
+
automated?: boolean;
|
|
2624
2774
|
/**
|
|
2625
|
-
*
|
|
2775
|
+
* Only posts in any of these languages (ISO 639-1).
|
|
2626
2776
|
*/
|
|
2627
|
-
|
|
2777
|
+
languages?: Array<string>;
|
|
2628
2778
|
/**
|
|
2629
|
-
*
|
|
2779
|
+
* Never posts in these languages; an unknown language still passes.
|
|
2630
2780
|
*/
|
|
2631
|
-
|
|
2781
|
+
notLanguages?: Array<string>;
|
|
2782
|
+
/**
|
|
2783
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
2784
|
+
*/
|
|
2785
|
+
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'>;
|
|
2786
|
+
/**
|
|
2787
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
2788
|
+
*/
|
|
2789
|
+
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'>;
|
|
2790
|
+
/**
|
|
2791
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
2792
|
+
*/
|
|
2793
|
+
organization?: boolean;
|
|
2794
|
+
/**
|
|
2795
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
2796
|
+
*/
|
|
2797
|
+
tags?: Array<string>;
|
|
2798
|
+
/**
|
|
2799
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
2800
|
+
*/
|
|
2801
|
+
notTags?: Array<string>;
|
|
2802
|
+
/**
|
|
2803
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
2804
|
+
*/
|
|
2805
|
+
labels?: Array<string>;
|
|
2806
|
+
/**
|
|
2807
|
+
* Never mentions carrying any of these labels.
|
|
2808
|
+
*/
|
|
2809
|
+
notLabels?: Array<string>;
|
|
2810
|
+
/**
|
|
2811
|
+
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
2812
|
+
*/
|
|
2813
|
+
linkHosts?: Array<string>;
|
|
2814
|
+
/**
|
|
2815
|
+
* Never posts linking to these hosts.
|
|
2816
|
+
*/
|
|
2817
|
+
notLinkHosts?: Array<string>;
|
|
2818
|
+
/**
|
|
2819
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
2820
|
+
*/
|
|
2821
|
+
subreddits?: Array<string>;
|
|
2822
|
+
/**
|
|
2823
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
2824
|
+
*/
|
|
2825
|
+
notSubreddits?: Array<string>;
|
|
2826
|
+
/**
|
|
2827
|
+
* Only authors with at least this many followers; unknown reach never passes.
|
|
2828
|
+
*/
|
|
2829
|
+
minFollowers?: number;
|
|
2830
|
+
/**
|
|
2831
|
+
* Only authors with at most this many followers; unknown reach never passes.
|
|
2832
|
+
*/
|
|
2833
|
+
maxFollowers?: number;
|
|
2834
|
+
/**
|
|
2835
|
+
* true: only replies and comments; false: only top-level posts.
|
|
2836
|
+
*/
|
|
2837
|
+
isReply?: boolean;
|
|
2838
|
+
/**
|
|
2839
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
2840
|
+
*/
|
|
2841
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
2842
|
+
/**
|
|
2843
|
+
* Never these authors: display names, handles or profile URLs.
|
|
2844
|
+
*/
|
|
2845
|
+
notAuthors?: Array<string>;
|
|
2846
|
+
/**
|
|
2847
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
2848
|
+
*/
|
|
2849
|
+
excludeAuthors?: Array<string>;
|
|
2850
|
+
/**
|
|
2851
|
+
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
2852
|
+
*/
|
|
2853
|
+
ratings?: Array<number>;
|
|
2854
|
+
/**
|
|
2855
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
2856
|
+
*/
|
|
2857
|
+
notRatings?: Array<number>;
|
|
2858
|
+
/**
|
|
2859
|
+
* 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.
|
|
2860
|
+
*/
|
|
2861
|
+
minLikes?: number;
|
|
2862
|
+
/**
|
|
2863
|
+
* 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.
|
|
2864
|
+
*/
|
|
2865
|
+
minReposts?: number;
|
|
2866
|
+
/**
|
|
2867
|
+
* 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.
|
|
2868
|
+
*/
|
|
2869
|
+
minReplies?: number;
|
|
2870
|
+
/**
|
|
2871
|
+
* 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.
|
|
2872
|
+
*/
|
|
2873
|
+
minQuotes?: number;
|
|
2874
|
+
/**
|
|
2875
|
+
* 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.
|
|
2876
|
+
*/
|
|
2877
|
+
minViews?: number;
|
|
2878
|
+
/**
|
|
2879
|
+
* 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.
|
|
2880
|
+
*/
|
|
2881
|
+
minBookmarks?: number;
|
|
2882
|
+
/**
|
|
2883
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
2884
|
+
*/
|
|
2885
|
+
anyOf?: Array<FilterGroup>;
|
|
2886
|
+
};
|
|
2887
|
+
/**
|
|
2888
|
+
* What it does to each mention the filter selects.
|
|
2889
|
+
*/
|
|
2890
|
+
actions: {
|
|
2891
|
+
/**
|
|
2892
|
+
* Labels it adds.
|
|
2893
|
+
*/
|
|
2894
|
+
addLabels: Array<string>;
|
|
2895
|
+
/**
|
|
2896
|
+
* The member it assigns, or null.
|
|
2897
|
+
*/
|
|
2898
|
+
assigneeId: string | null;
|
|
2632
2899
|
};
|
|
2900
|
+
/**
|
|
2901
|
+
* ISO 8601 timestamp, UTC.
|
|
2902
|
+
*/
|
|
2903
|
+
createdAt: string;
|
|
2904
|
+
/**
|
|
2905
|
+
* ISO 8601 timestamp, UTC.
|
|
2906
|
+
*/
|
|
2907
|
+
updatedAt: string;
|
|
2633
2908
|
};
|
|
2634
|
-
type
|
|
2909
|
+
type MentionSpikeEventData = {
|
|
2635
2910
|
/**
|
|
2636
2911
|
* The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
|
|
2637
2912
|
*/
|
|
@@ -2666,23 +2941,45 @@ type KeywordNoisyEventData = {
|
|
|
2666
2941
|
groupId: string;
|
|
2667
2942
|
};
|
|
2668
2943
|
/**
|
|
2669
|
-
* The
|
|
2944
|
+
* The stretch of time the counts cover, by match time.
|
|
2670
2945
|
*/
|
|
2671
|
-
|
|
2946
|
+
window: {
|
|
2947
|
+
/**
|
|
2948
|
+
* Start, inclusive.
|
|
2949
|
+
*/
|
|
2950
|
+
from: string;
|
|
2951
|
+
/**
|
|
2952
|
+
* End, exclusive.
|
|
2953
|
+
*/
|
|
2954
|
+
to: string;
|
|
2955
|
+
};
|
|
2672
2956
|
/**
|
|
2673
|
-
*
|
|
2957
|
+
* Fresh matches in the hour: posts published at most 6 hours before they matched. Look-backs and free reviews never count.
|
|
2674
2958
|
*/
|
|
2675
|
-
|
|
2959
|
+
matches: number;
|
|
2676
2960
|
/**
|
|
2677
|
-
* Of those, relevant.
|
|
2961
|
+
* Of those, scored relevant so far.
|
|
2678
2962
|
*/
|
|
2679
2963
|
relevant: number;
|
|
2680
2964
|
/**
|
|
2681
|
-
*
|
|
2965
|
+
* What the keyword usually gets.
|
|
2682
2966
|
*/
|
|
2683
|
-
|
|
2967
|
+
baseline: {
|
|
2968
|
+
/**
|
|
2969
|
+
* Fresh matches per hour over the baseline.
|
|
2970
|
+
*/
|
|
2971
|
+
meanPerHour: number;
|
|
2972
|
+
/**
|
|
2973
|
+
* Their standard deviation.
|
|
2974
|
+
*/
|
|
2975
|
+
stddevPerHour: number;
|
|
2976
|
+
/**
|
|
2977
|
+
* Hours in the baseline: the week before the window, or since the keyword started listening.
|
|
2978
|
+
*/
|
|
2979
|
+
hours: number;
|
|
2980
|
+
};
|
|
2684
2981
|
};
|
|
2685
|
-
type
|
|
2982
|
+
type NegativeSpikeEventData = {
|
|
2686
2983
|
/**
|
|
2687
2984
|
* The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
|
|
2688
2985
|
*/
|
|
@@ -2692,36 +2989,74 @@ type ChannelFailingEventData = {
|
|
|
2692
2989
|
*/
|
|
2693
2990
|
url: string;
|
|
2694
2991
|
/**
|
|
2695
|
-
* The
|
|
2992
|
+
* The keyword the item is about.
|
|
2696
2993
|
*/
|
|
2697
|
-
|
|
2994
|
+
keyword: {
|
|
2698
2995
|
/**
|
|
2699
|
-
*
|
|
2996
|
+
* Keyword id (kw_...).
|
|
2700
2997
|
*/
|
|
2701
2998
|
id: string;
|
|
2702
2999
|
/**
|
|
2703
|
-
*
|
|
3000
|
+
* The tracked term.
|
|
2704
3001
|
*/
|
|
2705
|
-
|
|
3002
|
+
term: string;
|
|
2706
3003
|
/**
|
|
2707
|
-
*
|
|
3004
|
+
* brand, competitor or topic.
|
|
2708
3005
|
*/
|
|
2709
|
-
|
|
3006
|
+
kind: 'brand' | 'competitor' | 'topic';
|
|
3007
|
+
/**
|
|
3008
|
+
* The keyword as Mentio names it: the term, or "term (Group)" outside the default group.
|
|
3009
|
+
*/
|
|
3010
|
+
name: string;
|
|
3011
|
+
/**
|
|
3012
|
+
* Its group (grp_...).
|
|
3013
|
+
*/
|
|
3014
|
+
groupId: string;
|
|
2710
3015
|
};
|
|
2711
3016
|
/**
|
|
2712
|
-
*
|
|
3017
|
+
* The stretch of time the counts cover, by match time.
|
|
2713
3018
|
*/
|
|
2714
|
-
|
|
3019
|
+
window: {
|
|
3020
|
+
/**
|
|
3021
|
+
* Start, inclusive.
|
|
3022
|
+
*/
|
|
3023
|
+
from: string;
|
|
3024
|
+
/**
|
|
3025
|
+
* End, exclusive.
|
|
3026
|
+
*/
|
|
3027
|
+
to: string;
|
|
3028
|
+
};
|
|
2715
3029
|
/**
|
|
2716
|
-
*
|
|
3030
|
+
* Relevant matches scored negative in the window.
|
|
2717
3031
|
*/
|
|
2718
|
-
|
|
3032
|
+
negative: number;
|
|
2719
3033
|
/**
|
|
2720
|
-
*
|
|
3034
|
+
* Relevant matches in the window.
|
|
2721
3035
|
*/
|
|
2722
|
-
|
|
3036
|
+
relevant: number;
|
|
3037
|
+
/**
|
|
3038
|
+
* negative / relevant.
|
|
3039
|
+
*/
|
|
3040
|
+
share: number;
|
|
3041
|
+
/**
|
|
3042
|
+
* What the keyword usually reads.
|
|
3043
|
+
*/
|
|
3044
|
+
baseline: {
|
|
3045
|
+
/**
|
|
3046
|
+
* Negative relevant matches in the 7 days before the window.
|
|
3047
|
+
*/
|
|
3048
|
+
negative: number;
|
|
3049
|
+
/**
|
|
3050
|
+
* Relevant matches in those 7 days.
|
|
3051
|
+
*/
|
|
3052
|
+
relevant: number;
|
|
3053
|
+
/**
|
|
3054
|
+
* The usual negative share, smoothed so a quiet week still has one.
|
|
3055
|
+
*/
|
|
3056
|
+
share: number;
|
|
3057
|
+
};
|
|
2723
3058
|
};
|
|
2724
|
-
type
|
|
3059
|
+
type KeywordNoisyEventData = {
|
|
2725
3060
|
/**
|
|
2726
3061
|
* The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
|
|
2727
3062
|
*/
|
|
@@ -2731,28 +3066,118 @@ type FeedFailingEventData = {
|
|
|
2731
3066
|
*/
|
|
2732
3067
|
url: string;
|
|
2733
3068
|
/**
|
|
2734
|
-
* The
|
|
3069
|
+
* The keyword the item is about.
|
|
2735
3070
|
*/
|
|
2736
|
-
|
|
3071
|
+
keyword: {
|
|
2737
3072
|
/**
|
|
2738
|
-
*
|
|
3073
|
+
* Keyword id (kw_...).
|
|
2739
3074
|
*/
|
|
2740
3075
|
id: string;
|
|
2741
3076
|
/**
|
|
2742
|
-
* The
|
|
3077
|
+
* The tracked term.
|
|
2743
3078
|
*/
|
|
2744
|
-
|
|
3079
|
+
term: string;
|
|
2745
3080
|
/**
|
|
2746
|
-
*
|
|
3081
|
+
* brand, competitor or topic.
|
|
2747
3082
|
*/
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
|
|
2753
|
-
|
|
2754
|
-
|
|
2755
|
-
|
|
3083
|
+
kind: 'brand' | 'competitor' | 'topic';
|
|
3084
|
+
/**
|
|
3085
|
+
* The keyword as Mentio names it: the term, or "term (Group)" outside the default group.
|
|
3086
|
+
*/
|
|
3087
|
+
name: string;
|
|
3088
|
+
/**
|
|
3089
|
+
* Its group (grp_...).
|
|
3090
|
+
*/
|
|
3091
|
+
groupId: string;
|
|
3092
|
+
};
|
|
3093
|
+
/**
|
|
3094
|
+
* The window the noise is measured over, in days (since the keyword's last change when that is inside it).
|
|
3095
|
+
*/
|
|
3096
|
+
windowDays: number;
|
|
3097
|
+
/**
|
|
3098
|
+
* Matches the classifier scored in that window.
|
|
3099
|
+
*/
|
|
3100
|
+
scored: number;
|
|
3101
|
+
/**
|
|
3102
|
+
* Of those, relevant.
|
|
3103
|
+
*/
|
|
3104
|
+
relevant: number;
|
|
3105
|
+
/**
|
|
3106
|
+
* The share scored under the relevance line. Every match bills, relevant or not.
|
|
3107
|
+
*/
|
|
3108
|
+
noiseShare: number;
|
|
3109
|
+
};
|
|
3110
|
+
type ChannelFailingEventData = {
|
|
3111
|
+
/**
|
|
3112
|
+
* The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
|
|
3113
|
+
*/
|
|
3114
|
+
attentionId: string;
|
|
3115
|
+
/**
|
|
3116
|
+
* Where to look in the dashboard.
|
|
3117
|
+
*/
|
|
3118
|
+
url: string;
|
|
3119
|
+
/**
|
|
3120
|
+
* The channel whose sends fail.
|
|
3121
|
+
*/
|
|
3122
|
+
channel: {
|
|
3123
|
+
/**
|
|
3124
|
+
* Channel id (dest_...).
|
|
3125
|
+
*/
|
|
3126
|
+
id: string;
|
|
3127
|
+
/**
|
|
3128
|
+
* slack, email, webhook or telegram.
|
|
3129
|
+
*/
|
|
3130
|
+
kind: 'slack' | 'email' | 'webhook' | 'telegram';
|
|
3131
|
+
/**
|
|
3132
|
+
* The channel's label.
|
|
3133
|
+
*/
|
|
3134
|
+
label: string;
|
|
3135
|
+
};
|
|
3136
|
+
/**
|
|
3137
|
+
* Failed sends in a row within the last 24 hours.
|
|
3138
|
+
*/
|
|
3139
|
+
failures: number;
|
|
3140
|
+
/**
|
|
3141
|
+
* The newest failure, as the transport reported it.
|
|
3142
|
+
*/
|
|
3143
|
+
lastError: string | null;
|
|
3144
|
+
/**
|
|
3145
|
+
* The oldest of those failures.
|
|
3146
|
+
*/
|
|
3147
|
+
since: string;
|
|
3148
|
+
};
|
|
3149
|
+
type FeedFailingEventData = {
|
|
3150
|
+
/**
|
|
3151
|
+
* The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
|
|
3152
|
+
*/
|
|
3153
|
+
attentionId: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* Where to look in the dashboard.
|
|
3156
|
+
*/
|
|
3157
|
+
url: string;
|
|
3158
|
+
/**
|
|
3159
|
+
* The workspace feed (GET /v1/feeds/{id}).
|
|
3160
|
+
*/
|
|
3161
|
+
feed: {
|
|
3162
|
+
/**
|
|
3163
|
+
* Feed id (fd_...).
|
|
3164
|
+
*/
|
|
3165
|
+
id: string;
|
|
3166
|
+
/**
|
|
3167
|
+
* The feed address.
|
|
3168
|
+
*/
|
|
3169
|
+
url: string;
|
|
3170
|
+
/**
|
|
3171
|
+
* The feed's own title, when it has one.
|
|
3172
|
+
*/
|
|
3173
|
+
title: string | null;
|
|
3174
|
+
};
|
|
3175
|
+
/**
|
|
3176
|
+
* - login_required: a sign-in or access-denied page; add the forum's sign-in.
|
|
3177
|
+
* - login_expired: the same with a sign-in; copy a fresh cookie.
|
|
3178
|
+
* - blocked: a 403, a 429 or a bot check.
|
|
3179
|
+
* - not_found: the feed is gone.
|
|
3180
|
+
* - not_a_feed: the address answers a page, not RSS or Atom.
|
|
2756
3181
|
* - unreachable: no answer or a server error.
|
|
2757
3182
|
*/
|
|
2758
3183
|
reason: 'login_required' | 'login_expired' | 'blocked' | 'not_found' | 'not_a_feed' | 'unreachable';
|
|
@@ -2990,8 +3415,17 @@ type Invitation = {
|
|
|
2990
3415
|
* Who sent it; an API key invites on behalf of the oldest owner.
|
|
2991
3416
|
*/
|
|
2992
3417
|
invitedBy: {
|
|
3418
|
+
/**
|
|
3419
|
+
* User id.
|
|
3420
|
+
*/
|
|
2993
3421
|
id: string;
|
|
3422
|
+
/**
|
|
3423
|
+
* Their email.
|
|
3424
|
+
*/
|
|
2994
3425
|
email: string;
|
|
3426
|
+
/**
|
|
3427
|
+
* Their name.
|
|
3428
|
+
*/
|
|
2995
3429
|
name: string | null;
|
|
2996
3430
|
} | null;
|
|
2997
3431
|
/**
|
|
@@ -3020,6 +3454,9 @@ type UsageSummary = {
|
|
|
3020
3454
|
* cents minus pendingCents: what the stop rule and the keyword gate look at.
|
|
3021
3455
|
*/
|
|
3022
3456
|
effectiveCents: number;
|
|
3457
|
+
/**
|
|
3458
|
+
* Always USD.
|
|
3459
|
+
*/
|
|
3023
3460
|
currency: 'USD';
|
|
3024
3461
|
};
|
|
3025
3462
|
/**
|
|
@@ -3339,6 +3776,9 @@ type Wallet = {
|
|
|
3339
3776
|
* Every amount on this page is in USD cents.
|
|
3340
3777
|
*/
|
|
3341
3778
|
currency: 'USD';
|
|
3779
|
+
/**
|
|
3780
|
+
* Automatic top-up: off unless set in the dashboard.
|
|
3781
|
+
*/
|
|
3342
3782
|
autoRecharge: {
|
|
3343
3783
|
/**
|
|
3344
3784
|
* This deployment can charge saved cards; false hides the setting.
|
|
@@ -3457,7 +3897,13 @@ type Alert = {
|
|
|
3457
3897
|
* Alert id (feed_...).
|
|
3458
3898
|
*/
|
|
3459
3899
|
id: string;
|
|
3900
|
+
/**
|
|
3901
|
+
* Rule name.
|
|
3902
|
+
*/
|
|
3460
3903
|
name: string;
|
|
3904
|
+
/**
|
|
3905
|
+
* false: the rule sends nothing.
|
|
3906
|
+
*/
|
|
3461
3907
|
enabled: boolean;
|
|
3462
3908
|
/**
|
|
3463
3909
|
* When it sends; see [Alerts](/alerts).
|
|
@@ -3468,6 +3914,9 @@ type Alert = {
|
|
|
3468
3914
|
* - weekly: one digest a week, on schedule.weekday.
|
|
3469
3915
|
*/
|
|
3470
3916
|
mode: 'instant' | 'hourly' | 'daily' | 'weekly';
|
|
3917
|
+
/**
|
|
3918
|
+
* Which mentions the rule sends.
|
|
3919
|
+
*/
|
|
3471
3920
|
filter: {
|
|
3472
3921
|
/**
|
|
3473
3922
|
* Only these keywords.
|
|
@@ -3509,6 +3958,14 @@ type Alert = {
|
|
|
3509
3958
|
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
3510
3959
|
*/
|
|
3511
3960
|
tags?: Array<string>;
|
|
3961
|
+
/**
|
|
3962
|
+
* Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
|
|
3963
|
+
*/
|
|
3964
|
+
labels?: Array<string>;
|
|
3965
|
+
/**
|
|
3966
|
+
* Never mentions carrying any of these labels.
|
|
3967
|
+
*/
|
|
3968
|
+
notLabels?: Array<string>;
|
|
3512
3969
|
/**
|
|
3513
3970
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
3514
3971
|
*/
|
|
@@ -3574,9 +4031,21 @@ type Alert = {
|
|
|
3574
4031
|
* Daily and weekly alerts only; null for instant and hourly ones.
|
|
3575
4032
|
*/
|
|
3576
4033
|
schedule: {
|
|
4034
|
+
/**
|
|
4035
|
+
* Hour of the day to send, 0 to 23, in timezone.
|
|
4036
|
+
*/
|
|
3577
4037
|
hour: number;
|
|
4038
|
+
/**
|
|
4039
|
+
* Minute past the hour, 0 to 59.
|
|
4040
|
+
*/
|
|
3578
4041
|
minute?: number;
|
|
4042
|
+
/**
|
|
4043
|
+
* IANA zone the schedule runs in (Europe/Madrid).
|
|
4044
|
+
*/
|
|
3579
4045
|
timezone: string;
|
|
4046
|
+
/**
|
|
4047
|
+
* true: send nothing when the window had no mention.
|
|
4048
|
+
*/
|
|
3580
4049
|
skipEmpty?: boolean;
|
|
3581
4050
|
/**
|
|
3582
4051
|
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
@@ -3591,8 +4060,17 @@ type Alert = {
|
|
|
3591
4060
|
* Where it sends.
|
|
3592
4061
|
*/
|
|
3593
4062
|
channels: Array<{
|
|
4063
|
+
/**
|
|
4064
|
+
* Channel id (dest_...).
|
|
4065
|
+
*/
|
|
3594
4066
|
id: string;
|
|
4067
|
+
/**
|
|
4068
|
+
* Channel kind.
|
|
4069
|
+
*/
|
|
3595
4070
|
kind: 'slack' | 'email' | 'webhook' | 'telegram';
|
|
4071
|
+
/**
|
|
4072
|
+
* Channel name.
|
|
4073
|
+
*/
|
|
3596
4074
|
label: string;
|
|
3597
4075
|
}>;
|
|
3598
4076
|
/**
|
|
@@ -4221,6 +4699,9 @@ type ReviewsReport = {
|
|
|
4221
4699
|
*/
|
|
4222
4700
|
bucket: 'day' | 'week';
|
|
4223
4701
|
};
|
|
4702
|
+
/**
|
|
4703
|
+
* The window's review count and average rating.
|
|
4704
|
+
*/
|
|
4224
4705
|
totals: {
|
|
4225
4706
|
/**
|
|
4226
4707
|
* Reviews published in the window; a review matched by two keywords counts once.
|
|
@@ -4234,10 +4715,25 @@ type ReviewsReport = {
|
|
|
4234
4715
|
* Reviews per star rating.
|
|
4235
4716
|
*/
|
|
4236
4717
|
distribution: {
|
|
4718
|
+
/**
|
|
4719
|
+
* One star.
|
|
4720
|
+
*/
|
|
4237
4721
|
1: number;
|
|
4722
|
+
/**
|
|
4723
|
+
* Two stars.
|
|
4724
|
+
*/
|
|
4238
4725
|
2: number;
|
|
4726
|
+
/**
|
|
4727
|
+
* Three stars.
|
|
4728
|
+
*/
|
|
4239
4729
|
3: number;
|
|
4730
|
+
/**
|
|
4731
|
+
* Four stars.
|
|
4732
|
+
*/
|
|
4240
4733
|
4: number;
|
|
4734
|
+
/**
|
|
4735
|
+
* Five stars.
|
|
4736
|
+
*/
|
|
4241
4737
|
5: number;
|
|
4242
4738
|
};
|
|
4243
4739
|
/**
|
|
@@ -4253,7 +4749,13 @@ type ReviewsReport = {
|
|
|
4253
4749
|
* Intent and topic tags on the 1 and 2 star reviews, most frequent first: what the unhappy ones are about.
|
|
4254
4750
|
*/
|
|
4255
4751
|
tags: Array<{
|
|
4752
|
+
/**
|
|
4753
|
+
* The intent or topic tag.
|
|
4754
|
+
*/
|
|
4256
4755
|
tag: string;
|
|
4756
|
+
/**
|
|
4757
|
+
* Reviews carrying it.
|
|
4758
|
+
*/
|
|
4257
4759
|
count: number;
|
|
4258
4760
|
}>;
|
|
4259
4761
|
/**
|
|
@@ -4272,10 +4774,25 @@ type ReviewsReport = {
|
|
|
4272
4774
|
* Reviews per star rating.
|
|
4273
4775
|
*/
|
|
4274
4776
|
distribution: {
|
|
4777
|
+
/**
|
|
4778
|
+
* One star.
|
|
4779
|
+
*/
|
|
4275
4780
|
1: number;
|
|
4781
|
+
/**
|
|
4782
|
+
* Two stars.
|
|
4783
|
+
*/
|
|
4276
4784
|
2: number;
|
|
4785
|
+
/**
|
|
4786
|
+
* Three stars.
|
|
4787
|
+
*/
|
|
4277
4788
|
3: number;
|
|
4789
|
+
/**
|
|
4790
|
+
* Four stars.
|
|
4791
|
+
*/
|
|
4278
4792
|
4: number;
|
|
4793
|
+
/**
|
|
4794
|
+
* Five stars.
|
|
4795
|
+
*/
|
|
4279
4796
|
5: number;
|
|
4280
4797
|
};
|
|
4281
4798
|
/**
|
|
@@ -4306,6 +4823,9 @@ type ReviewsReport = {
|
|
|
4306
4823
|
* Bucket start, YYYY-MM-DD.
|
|
4307
4824
|
*/
|
|
4308
4825
|
date: string;
|
|
4826
|
+
/**
|
|
4827
|
+
* Reviews in the bucket.
|
|
4828
|
+
*/
|
|
4309
4829
|
reviews: number;
|
|
4310
4830
|
/**
|
|
4311
4831
|
* Average stars, one decimal; null with no reviews.
|
|
@@ -4316,6 +4836,9 @@ type ReviewsReport = {
|
|
|
4316
4836
|
* The period of the same length right before the window, with compare=true; else null.
|
|
4317
4837
|
*/
|
|
4318
4838
|
previous: {
|
|
4839
|
+
/**
|
|
4840
|
+
* Reviews in the window.
|
|
4841
|
+
*/
|
|
4319
4842
|
reviews: number;
|
|
4320
4843
|
/**
|
|
4321
4844
|
* Average stars, one decimal; null with no reviews.
|
|
@@ -4339,10 +4862,25 @@ type ReviewsReport = {
|
|
|
4339
4862
|
* Reviews per star rating.
|
|
4340
4863
|
*/
|
|
4341
4864
|
distribution: {
|
|
4865
|
+
/**
|
|
4866
|
+
* One star.
|
|
4867
|
+
*/
|
|
4342
4868
|
1: number;
|
|
4869
|
+
/**
|
|
4870
|
+
* Two stars.
|
|
4871
|
+
*/
|
|
4343
4872
|
2: number;
|
|
4873
|
+
/**
|
|
4874
|
+
* Three stars.
|
|
4875
|
+
*/
|
|
4344
4876
|
3: number;
|
|
4877
|
+
/**
|
|
4878
|
+
* Four stars.
|
|
4879
|
+
*/
|
|
4345
4880
|
4: number;
|
|
4881
|
+
/**
|
|
4882
|
+
* Five stars.
|
|
4883
|
+
*/
|
|
4346
4884
|
5: number;
|
|
4347
4885
|
};
|
|
4348
4886
|
/**
|
|
@@ -4360,6 +4898,9 @@ type SlackChannel = {
|
|
|
4360
4898
|
* Channel id (dest_...).
|
|
4361
4899
|
*/
|
|
4362
4900
|
id: string;
|
|
4901
|
+
/**
|
|
4902
|
+
* Your name for the channel.
|
|
4903
|
+
*/
|
|
4363
4904
|
label: string;
|
|
4364
4905
|
/**
|
|
4365
4906
|
* Computed over this workspace's deliveries.
|
|
@@ -4381,7 +4922,13 @@ type SlackChannel = {
|
|
|
4381
4922
|
* Deliveries in the last 7 days.
|
|
4382
4923
|
*/
|
|
4383
4924
|
last7d: {
|
|
4925
|
+
/**
|
|
4926
|
+
* Sends attempted.
|
|
4927
|
+
*/
|
|
4384
4928
|
total: number;
|
|
4929
|
+
/**
|
|
4930
|
+
* Sends that failed.
|
|
4931
|
+
*/
|
|
4385
4932
|
failed: number;
|
|
4386
4933
|
};
|
|
4387
4934
|
};
|
|
@@ -4389,7 +4936,13 @@ type SlackChannel = {
|
|
|
4389
4936
|
* ISO 8601 timestamp, UTC.
|
|
4390
4937
|
*/
|
|
4391
4938
|
createdAt: string;
|
|
4939
|
+
/**
|
|
4940
|
+
* Channel kind.
|
|
4941
|
+
*/
|
|
4392
4942
|
kind: 'slack';
|
|
4943
|
+
/**
|
|
4944
|
+
* The channel's settings for its kind; secrets are never returned.
|
|
4945
|
+
*/
|
|
4393
4946
|
config: {
|
|
4394
4947
|
/**
|
|
4395
4948
|
* Slack channel id.
|
|
@@ -4410,6 +4963,9 @@ type EmailChannel = {
|
|
|
4410
4963
|
* Channel id (dest_...).
|
|
4411
4964
|
*/
|
|
4412
4965
|
id: string;
|
|
4966
|
+
/**
|
|
4967
|
+
* Your name for the channel.
|
|
4968
|
+
*/
|
|
4413
4969
|
label: string;
|
|
4414
4970
|
/**
|
|
4415
4971
|
* Computed over this workspace's deliveries.
|
|
@@ -4431,7 +4987,13 @@ type EmailChannel = {
|
|
|
4431
4987
|
* Deliveries in the last 7 days.
|
|
4432
4988
|
*/
|
|
4433
4989
|
last7d: {
|
|
4990
|
+
/**
|
|
4991
|
+
* Sends attempted.
|
|
4992
|
+
*/
|
|
4434
4993
|
total: number;
|
|
4994
|
+
/**
|
|
4995
|
+
* Sends that failed.
|
|
4996
|
+
*/
|
|
4435
4997
|
failed: number;
|
|
4436
4998
|
};
|
|
4437
4999
|
};
|
|
@@ -4439,12 +5001,21 @@ type EmailChannel = {
|
|
|
4439
5001
|
* ISO 8601 timestamp, UTC.
|
|
4440
5002
|
*/
|
|
4441
5003
|
createdAt: string;
|
|
5004
|
+
/**
|
|
5005
|
+
* Channel kind.
|
|
5006
|
+
*/
|
|
4442
5007
|
kind: 'email';
|
|
5008
|
+
/**
|
|
5009
|
+
* The channel's settings for its kind; secrets are never returned.
|
|
5010
|
+
*/
|
|
4443
5011
|
config: {
|
|
4444
5012
|
/**
|
|
4445
5013
|
* Every address on the list and whether it confirmed.
|
|
4446
5014
|
*/
|
|
4447
5015
|
recipients: Array<{
|
|
5016
|
+
/**
|
|
5017
|
+
* Recipient address.
|
|
5018
|
+
*/
|
|
4448
5019
|
email: string;
|
|
4449
5020
|
/**
|
|
4450
5021
|
* Null until the address confirmed through its link; unconfirmed addresses receive nothing.
|
|
@@ -4462,6 +5033,9 @@ type WebhookChannel = {
|
|
|
4462
5033
|
* Channel id (dest_...).
|
|
4463
5034
|
*/
|
|
4464
5035
|
id: string;
|
|
5036
|
+
/**
|
|
5037
|
+
* Your name for the channel.
|
|
5038
|
+
*/
|
|
4465
5039
|
label: string;
|
|
4466
5040
|
/**
|
|
4467
5041
|
* Computed over this workspace's deliveries.
|
|
@@ -4483,7 +5057,13 @@ type WebhookChannel = {
|
|
|
4483
5057
|
* Deliveries in the last 7 days.
|
|
4484
5058
|
*/
|
|
4485
5059
|
last7d: {
|
|
5060
|
+
/**
|
|
5061
|
+
* Sends attempted.
|
|
5062
|
+
*/
|
|
4486
5063
|
total: number;
|
|
5064
|
+
/**
|
|
5065
|
+
* Sends that failed.
|
|
5066
|
+
*/
|
|
4487
5067
|
failed: number;
|
|
4488
5068
|
};
|
|
4489
5069
|
};
|
|
@@ -4491,7 +5071,13 @@ type WebhookChannel = {
|
|
|
4491
5071
|
* ISO 8601 timestamp, UTC.
|
|
4492
5072
|
*/
|
|
4493
5073
|
createdAt: string;
|
|
5074
|
+
/**
|
|
5075
|
+
* Channel kind.
|
|
5076
|
+
*/
|
|
4494
5077
|
kind: 'webhook';
|
|
5078
|
+
/**
|
|
5079
|
+
* The channel's settings for its kind; secrets are never returned.
|
|
5080
|
+
*/
|
|
4495
5081
|
config: {
|
|
4496
5082
|
/**
|
|
4497
5083
|
* Where the signed POSTs go.
|
|
@@ -4518,6 +5104,9 @@ type TelegramChannel = {
|
|
|
4518
5104
|
* Channel id (dest_...).
|
|
4519
5105
|
*/
|
|
4520
5106
|
id: string;
|
|
5107
|
+
/**
|
|
5108
|
+
* Your name for the channel.
|
|
5109
|
+
*/
|
|
4521
5110
|
label: string;
|
|
4522
5111
|
/**
|
|
4523
5112
|
* Computed over this workspace's deliveries.
|
|
@@ -4539,7 +5128,13 @@ type TelegramChannel = {
|
|
|
4539
5128
|
* Deliveries in the last 7 days.
|
|
4540
5129
|
*/
|
|
4541
5130
|
last7d: {
|
|
5131
|
+
/**
|
|
5132
|
+
* Sends attempted.
|
|
5133
|
+
*/
|
|
4542
5134
|
total: number;
|
|
5135
|
+
/**
|
|
5136
|
+
* Sends that failed.
|
|
5137
|
+
*/
|
|
4543
5138
|
failed: number;
|
|
4544
5139
|
};
|
|
4545
5140
|
};
|
|
@@ -4547,12 +5142,21 @@ type TelegramChannel = {
|
|
|
4547
5142
|
* ISO 8601 timestamp, UTC.
|
|
4548
5143
|
*/
|
|
4549
5144
|
createdAt: string;
|
|
5145
|
+
/**
|
|
5146
|
+
* Channel kind.
|
|
5147
|
+
*/
|
|
4550
5148
|
kind: 'telegram';
|
|
5149
|
+
/**
|
|
5150
|
+
* The channel's settings for its kind; secrets are never returned.
|
|
5151
|
+
*/
|
|
4551
5152
|
config: {
|
|
4552
5153
|
/**
|
|
4553
5154
|
* Telegram chat id.
|
|
4554
5155
|
*/
|
|
4555
5156
|
chatId: string;
|
|
5157
|
+
/**
|
|
5158
|
+
* private, group, supergroup or channel.
|
|
5159
|
+
*/
|
|
4556
5160
|
chatType: 'private' | 'group' | 'supergroup' | 'channel';
|
|
4557
5161
|
/**
|
|
4558
5162
|
* The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
|
|
@@ -4570,6 +5174,9 @@ type Channel = ({
|
|
|
4570
5174
|
kind: 'telegram';
|
|
4571
5175
|
} & TelegramChannel);
|
|
4572
5176
|
type CreateSlackChannel = {
|
|
5177
|
+
/**
|
|
5178
|
+
* Channel kind.
|
|
5179
|
+
*/
|
|
4573
5180
|
kind: 'slack';
|
|
4574
5181
|
/**
|
|
4575
5182
|
* A Slack channel id from the connected workspace.
|
|
@@ -4585,6 +5192,9 @@ type CreateSlackChannel = {
|
|
|
4585
5192
|
events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4586
5193
|
};
|
|
4587
5194
|
type CreateEmailChannel = {
|
|
5195
|
+
/**
|
|
5196
|
+
* Channel kind.
|
|
5197
|
+
*/
|
|
4588
5198
|
kind: 'email';
|
|
4589
5199
|
/**
|
|
4590
5200
|
* Each address gets a confirmation link; workspace members are confirmed on sight.
|
|
@@ -4596,6 +5206,9 @@ type CreateEmailChannel = {
|
|
|
4596
5206
|
events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4597
5207
|
};
|
|
4598
5208
|
type CreateWebhookChannel = {
|
|
5209
|
+
/**
|
|
5210
|
+
* Channel kind.
|
|
5211
|
+
*/
|
|
4599
5212
|
kind: 'webhook';
|
|
4600
5213
|
/**
|
|
4601
5214
|
* Where the signed POSTs go. https in production.
|
|
@@ -4627,6 +5240,9 @@ type GetHealthResponses = {
|
|
|
4627
5240
|
* API is up
|
|
4628
5241
|
*/
|
|
4629
5242
|
200: {
|
|
5243
|
+
/**
|
|
5244
|
+
* Always true when the API answers.
|
|
5245
|
+
*/
|
|
4630
5246
|
ok: boolean;
|
|
4631
5247
|
};
|
|
4632
5248
|
};
|
|
@@ -4726,12 +5342,21 @@ type ListKeywordsResponses = {
|
|
|
4726
5342
|
* The matching keywords and how many there are
|
|
4727
5343
|
*/
|
|
4728
5344
|
200: {
|
|
5345
|
+
/**
|
|
5346
|
+
* The keywords.
|
|
5347
|
+
*/
|
|
4729
5348
|
data: Array<{
|
|
4730
5349
|
/**
|
|
4731
5350
|
* Keyword id (kw_...).
|
|
4732
5351
|
*/
|
|
4733
5352
|
id: string;
|
|
5353
|
+
/**
|
|
5354
|
+
* The tracked text, as typed.
|
|
5355
|
+
*/
|
|
4734
5356
|
term: string;
|
|
5357
|
+
/**
|
|
5358
|
+
* brand (your own name), competitor, or topic.
|
|
5359
|
+
*/
|
|
4735
5360
|
kind: 'brand' | 'competitor' | 'topic';
|
|
4736
5361
|
/**
|
|
4737
5362
|
* Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
|
|
@@ -5240,6 +5865,10 @@ type CreateKeywordData = {
|
|
|
5240
5865
|
url: '/v1/keywords';
|
|
5241
5866
|
};
|
|
5242
5867
|
type CreateKeywordErrors = {
|
|
5868
|
+
/**
|
|
5869
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
5870
|
+
*/
|
|
5871
|
+
400: ErrorResponse;
|
|
5243
5872
|
/**
|
|
5244
5873
|
* Missing or invalid API key
|
|
5245
5874
|
*/
|
|
@@ -5522,6 +6151,10 @@ type UpdateKeywordData = {
|
|
|
5522
6151
|
url: '/v1/keywords/{id}';
|
|
5523
6152
|
};
|
|
5524
6153
|
type UpdateKeywordErrors = {
|
|
6154
|
+
/**
|
|
6155
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
6156
|
+
*/
|
|
6157
|
+
400: ErrorResponse;
|
|
5525
6158
|
/**
|
|
5526
6159
|
* Missing or invalid API key
|
|
5527
6160
|
*/
|
|
@@ -5624,6 +6257,10 @@ type DuplicateKeywordData = {
|
|
|
5624
6257
|
url: '/v1/keywords/{id}/duplicate';
|
|
5625
6258
|
};
|
|
5626
6259
|
type DuplicateKeywordErrors = {
|
|
6260
|
+
/**
|
|
6261
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
6262
|
+
*/
|
|
6263
|
+
400: ErrorResponse;
|
|
5627
6264
|
/**
|
|
5628
6265
|
* Missing or invalid API key
|
|
5629
6266
|
*/
|
|
@@ -5669,6 +6306,10 @@ type ListFeedsData = {
|
|
|
5669
6306
|
url: '/v1/feeds';
|
|
5670
6307
|
};
|
|
5671
6308
|
type ListFeedsErrors = {
|
|
6309
|
+
/**
|
|
6310
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
6311
|
+
*/
|
|
6312
|
+
400: ErrorResponse;
|
|
5672
6313
|
/**
|
|
5673
6314
|
* Missing or invalid API key
|
|
5674
6315
|
*/
|
|
@@ -5865,11 +6506,21 @@ type ImportFeedsData = {
|
|
|
5865
6506
|
};
|
|
5866
6507
|
}>;
|
|
5867
6508
|
};
|
|
6509
|
+
headers?: {
|
|
6510
|
+
/**
|
|
6511
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
6512
|
+
*/
|
|
6513
|
+
'idempotency-key'?: string;
|
|
6514
|
+
};
|
|
5868
6515
|
path?: never;
|
|
5869
6516
|
query?: never;
|
|
5870
6517
|
url: '/v1/feeds/import';
|
|
5871
6518
|
};
|
|
5872
6519
|
type ImportFeedsErrors = {
|
|
6520
|
+
/**
|
|
6521
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
6522
|
+
*/
|
|
6523
|
+
400: ErrorResponse;
|
|
5873
6524
|
/**
|
|
5874
6525
|
* Missing or invalid API key
|
|
5875
6526
|
*/
|
|
@@ -6190,9 +6841,65 @@ type UpdateFiltersResponses = {
|
|
|
6190
6841
|
200: WorkspaceFilters;
|
|
6191
6842
|
};
|
|
6192
6843
|
type UpdateFiltersResponse = UpdateFiltersResponses[keyof UpdateFiltersResponses];
|
|
6193
|
-
type
|
|
6194
|
-
body
|
|
6195
|
-
|
|
6844
|
+
type UpdateMentionsData = {
|
|
6845
|
+
body: {
|
|
6846
|
+
/**
|
|
6847
|
+
* Mention ids (mm_...), 1 to 100: a page of GET /v1/mentions.
|
|
6848
|
+
*/
|
|
6849
|
+
ids: Array<string>;
|
|
6850
|
+
/**
|
|
6851
|
+
* Every field is optional, at least one is required; omitted fields are untouched.
|
|
6852
|
+
*/
|
|
6853
|
+
update: {
|
|
6854
|
+
/**
|
|
6855
|
+
* ignored or done to handle them; open to put them back.
|
|
6856
|
+
*/
|
|
6857
|
+
status?: 'open' | 'ignored' | 'done';
|
|
6858
|
+
/**
|
|
6859
|
+
* A workspace member (user id), or null to unassign.
|
|
6860
|
+
*/
|
|
6861
|
+
assigneeId?: string | null;
|
|
6862
|
+
/**
|
|
6863
|
+
* Labels to add; a mention keeps at most 20, and labels past that are not added.
|
|
6864
|
+
*/
|
|
6865
|
+
addLabels?: Array<string>;
|
|
6866
|
+
/**
|
|
6867
|
+
* Labels to remove; a label a mention does not carry is ignored.
|
|
6868
|
+
*/
|
|
6869
|
+
removeLabels?: Array<string>;
|
|
6870
|
+
};
|
|
6871
|
+
};
|
|
6872
|
+
headers?: {
|
|
6873
|
+
/**
|
|
6874
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
6875
|
+
*/
|
|
6876
|
+
'idempotency-key'?: string;
|
|
6877
|
+
};
|
|
6878
|
+
path?: never;
|
|
6879
|
+
query?: never;
|
|
6880
|
+
url: '/v1/mentions/batch';
|
|
6881
|
+
};
|
|
6882
|
+
type UpdateMentionsErrors = {
|
|
6883
|
+
/**
|
|
6884
|
+
* Invalid request (an empty update, more than 100 ids), or invalid_assignee: the assignee is not a workspace member
|
|
6885
|
+
*/
|
|
6886
|
+
400: ErrorResponse;
|
|
6887
|
+
/**
|
|
6888
|
+
* Missing or invalid API key
|
|
6889
|
+
*/
|
|
6890
|
+
401: ErrorResponse;
|
|
6891
|
+
};
|
|
6892
|
+
type UpdateMentionsError = UpdateMentionsErrors[keyof UpdateMentionsErrors];
|
|
6893
|
+
type UpdateMentionsResponses = {
|
|
6894
|
+
/**
|
|
6895
|
+
* Which mentions changed, and which ids were not found
|
|
6896
|
+
*/
|
|
6897
|
+
200: MentionBatchResult;
|
|
6898
|
+
};
|
|
6899
|
+
type UpdateMentionsResponse = UpdateMentionsResponses[keyof UpdateMentionsResponses];
|
|
6900
|
+
type GetMentionData = {
|
|
6901
|
+
body?: never;
|
|
6902
|
+
path: {
|
|
6196
6903
|
/**
|
|
6197
6904
|
* Mention id (mm_...).
|
|
6198
6905
|
*/
|
|
@@ -6240,6 +6947,10 @@ type UpdateMentionData = {
|
|
|
6240
6947
|
* Internal note; null or empty clears it.
|
|
6241
6948
|
*/
|
|
6242
6949
|
note?: string | null;
|
|
6950
|
+
/**
|
|
6951
|
+
* Replaces the mention's whole list of labels (exact, case-sensitive, at most 20); [] removes every label. To add or remove a few without reading first, use POST /v1/mentions/batch.
|
|
6952
|
+
*/
|
|
6953
|
+
labels?: Array<string>;
|
|
6243
6954
|
/**
|
|
6244
6955
|
* Your verdict: true sets relevance to 100 (a filtered mention becomes relevant), false to 0; null restores the classifier's score. Billing never changes. 409 classification_pending while it is still being classified.
|
|
6245
6956
|
*/
|
|
@@ -6398,6 +7109,10 @@ type SearchMentionsData = {
|
|
|
6398
7109
|
* Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
|
|
6399
7110
|
*/
|
|
6400
7111
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
7112
|
+
/**
|
|
7113
|
+
* Never matches of keywords of these kinds. Repeatable, or comma-separated.
|
|
7114
|
+
*/
|
|
7115
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
6401
7116
|
/**
|
|
6402
7117
|
* 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.
|
|
6403
7118
|
*/
|
|
@@ -6462,6 +7177,14 @@ type SearchMentionsData = {
|
|
|
6462
7177
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
6463
7178
|
*/
|
|
6464
7179
|
notTags?: Array<string> | null;
|
|
7180
|
+
/**
|
|
7181
|
+
* Only mentions carrying any of these labels (exact, case-sensitive). Repeatable, or comma-separated.
|
|
7182
|
+
*/
|
|
7183
|
+
labels?: Array<string> | null;
|
|
7184
|
+
/**
|
|
7185
|
+
* Never mentions carrying any of these labels. Repeatable, or comma-separated.
|
|
7186
|
+
*/
|
|
7187
|
+
notLabels?: Array<string> | null;
|
|
6465
7188
|
/**
|
|
6466
7189
|
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
6467
7190
|
*/
|
|
@@ -6577,6 +7300,9 @@ type SearchMentionsResponses = {
|
|
|
6577
7300
|
* One page of mentions in the requested order
|
|
6578
7301
|
*/
|
|
6579
7302
|
200: {
|
|
7303
|
+
/**
|
|
7304
|
+
* The page of mentions.
|
|
7305
|
+
*/
|
|
6580
7306
|
data: Array<Mention>;
|
|
6581
7307
|
/**
|
|
6582
7308
|
* Pass as cursor for the next page; null on the last page.
|
|
@@ -6699,6 +7425,10 @@ type ExportMentionsCsvData = {
|
|
|
6699
7425
|
* Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
|
|
6700
7426
|
*/
|
|
6701
7427
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
7428
|
+
/**
|
|
7429
|
+
* Never matches of keywords of these kinds. Repeatable, or comma-separated.
|
|
7430
|
+
*/
|
|
7431
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
6702
7432
|
/**
|
|
6703
7433
|
* 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.
|
|
6704
7434
|
*/
|
|
@@ -6763,6 +7493,14 @@ type ExportMentionsCsvData = {
|
|
|
6763
7493
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
6764
7494
|
*/
|
|
6765
7495
|
notTags?: Array<string> | null;
|
|
7496
|
+
/**
|
|
7497
|
+
* Only mentions carrying any of these labels (exact, case-sensitive). Repeatable, or comma-separated.
|
|
7498
|
+
*/
|
|
7499
|
+
labels?: Array<string> | null;
|
|
7500
|
+
/**
|
|
7501
|
+
* Never mentions carrying any of these labels. Repeatable, or comma-separated.
|
|
7502
|
+
*/
|
|
7503
|
+
notLabels?: Array<string> | null;
|
|
6766
7504
|
/**
|
|
6767
7505
|
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
6768
7506
|
*/
|
|
@@ -6912,6 +7650,9 @@ type ListMentionCommentsResponses = {
|
|
|
6912
7650
|
* One page of the thread, newest first
|
|
6913
7651
|
*/
|
|
6914
7652
|
200: {
|
|
7653
|
+
/**
|
|
7654
|
+
* The page of comments, newest first.
|
|
7655
|
+
*/
|
|
6915
7656
|
data: Array<MentionComment>;
|
|
6916
7657
|
/**
|
|
6917
7658
|
* Pass as cursor for the next page; null on the last page.
|
|
@@ -7034,6 +7775,10 @@ type ExportMentionsJsonData = {
|
|
|
7034
7775
|
* Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
|
|
7035
7776
|
*/
|
|
7036
7777
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
7778
|
+
/**
|
|
7779
|
+
* Never matches of keywords of these kinds. Repeatable, or comma-separated.
|
|
7780
|
+
*/
|
|
7781
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
7037
7782
|
/**
|
|
7038
7783
|
* 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.
|
|
7039
7784
|
*/
|
|
@@ -7098,6 +7843,14 @@ type ExportMentionsJsonData = {
|
|
|
7098
7843
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
7099
7844
|
*/
|
|
7100
7845
|
notTags?: Array<string> | null;
|
|
7846
|
+
/**
|
|
7847
|
+
* Only mentions carrying any of these labels (exact, case-sensitive). Repeatable, or comma-separated.
|
|
7848
|
+
*/
|
|
7849
|
+
labels?: Array<string> | null;
|
|
7850
|
+
/**
|
|
7851
|
+
* Never mentions carrying any of these labels. Repeatable, or comma-separated.
|
|
7852
|
+
*/
|
|
7853
|
+
notLabels?: Array<string> | null;
|
|
7101
7854
|
/**
|
|
7102
7855
|
* Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
|
|
7103
7856
|
*/
|
|
@@ -7334,6 +8087,18 @@ type ExportPeopleCsvData = {
|
|
|
7334
8087
|
* People at any of these outreach stages. Repeatable, or comma-separated.
|
|
7335
8088
|
*/
|
|
7336
8089
|
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
8090
|
+
/**
|
|
8091
|
+
* Nobody at these outreach stages. Repeatable, or comma-separated.
|
|
8092
|
+
*/
|
|
8093
|
+
notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
8094
|
+
/**
|
|
8095
|
+
* Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it. Repeatable, or comma-separated.
|
|
8096
|
+
*/
|
|
8097
|
+
notLinkHosts?: Array<string> | null;
|
|
8098
|
+
/**
|
|
8099
|
+
* Nobody owned by these members (user ids); `none` drops the people nobody owns. Repeatable, or comma-separated.
|
|
8100
|
+
*/
|
|
8101
|
+
notOwnerIds?: Array<string> | null;
|
|
7337
8102
|
/**
|
|
7338
8103
|
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest; omitted: everyone.
|
|
7339
8104
|
*/
|
|
@@ -7493,6 +8258,18 @@ type ListPeopleData = {
|
|
|
7493
8258
|
* People at any of these outreach stages. Repeatable, or comma-separated.
|
|
7494
8259
|
*/
|
|
7495
8260
|
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
8261
|
+
/**
|
|
8262
|
+
* Nobody at these outreach stages. Repeatable, or comma-separated.
|
|
8263
|
+
*/
|
|
8264
|
+
notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
8265
|
+
/**
|
|
8266
|
+
* Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it. Repeatable, or comma-separated.
|
|
8267
|
+
*/
|
|
8268
|
+
notLinkHosts?: Array<string> | null;
|
|
8269
|
+
/**
|
|
8270
|
+
* Nobody owned by these members (user ids); `none` drops the people nobody owns. Repeatable, or comma-separated.
|
|
8271
|
+
*/
|
|
8272
|
+
notOwnerIds?: Array<string> | null;
|
|
7496
8273
|
/**
|
|
7497
8274
|
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest; omitted: everyone.
|
|
7498
8275
|
*/
|
|
@@ -7536,6 +8313,9 @@ type ListPeopleResponses = {
|
|
|
7536
8313
|
* One page of people
|
|
7537
8314
|
*/
|
|
7538
8315
|
200: {
|
|
8316
|
+
/**
|
|
8317
|
+
* The page of people.
|
|
8318
|
+
*/
|
|
7539
8319
|
data: Array<{
|
|
7540
8320
|
/**
|
|
7541
8321
|
* Person id (aut_...): the canonical account. An account merged into someone resolves to that person.
|
|
@@ -7557,6 +8337,9 @@ type ListPeopleResponses = {
|
|
|
7557
8337
|
* Profile URL of the canonical account.
|
|
7558
8338
|
*/
|
|
7559
8339
|
url: string | null;
|
|
8340
|
+
/**
|
|
8341
|
+
* Profile picture URL.
|
|
8342
|
+
*/
|
|
7560
8343
|
avatarUrl: string | null;
|
|
7561
8344
|
/**
|
|
7562
8345
|
* Every account this workspace treats as this person, the canonical one first.
|
|
@@ -7587,17 +8370,38 @@ type ListPeopleResponses = {
|
|
|
7587
8370
|
* Platform counts as of their newest post; null where the platform has no such number.
|
|
7588
8371
|
*/
|
|
7589
8372
|
reach: {
|
|
8373
|
+
/**
|
|
8374
|
+
* Followers when last seen; null when unknown.
|
|
8375
|
+
*/
|
|
7590
8376
|
followers: number | null;
|
|
8377
|
+
/**
|
|
8378
|
+
* Accounts they follow; null when unknown.
|
|
8379
|
+
*/
|
|
7591
8380
|
following: number | null;
|
|
8381
|
+
/**
|
|
8382
|
+
* Posts on the platform; null when unknown.
|
|
8383
|
+
*/
|
|
7592
8384
|
posts: number | null;
|
|
7593
8385
|
};
|
|
7594
8386
|
/**
|
|
7595
8387
|
* Public profile facts; null until looked up.
|
|
7596
8388
|
*/
|
|
7597
8389
|
profile: {
|
|
8390
|
+
/**
|
|
8391
|
+
* The profile's bio, as the platform shows it.
|
|
8392
|
+
*/
|
|
7598
8393
|
bio: string | null;
|
|
8394
|
+
/**
|
|
8395
|
+
* Company named on the profile.
|
|
8396
|
+
*/
|
|
7599
8397
|
company: string | null;
|
|
8398
|
+
/**
|
|
8399
|
+
* Location named on the profile.
|
|
8400
|
+
*/
|
|
7600
8401
|
location: string | null;
|
|
8402
|
+
/**
|
|
8403
|
+
* Website linked from the profile.
|
|
8404
|
+
*/
|
|
7601
8405
|
website: string | null;
|
|
7602
8406
|
/**
|
|
7603
8407
|
* Only when the person made it public on the platform.
|
|
@@ -7607,7 +8411,13 @@ type ListPeopleResponses = {
|
|
|
7607
8411
|
* Other accounts the person lists on their profile.
|
|
7608
8412
|
*/
|
|
7609
8413
|
links: Array<{
|
|
8414
|
+
/**
|
|
8415
|
+
* The platform or kind of the linked account (github, x, website, ...).
|
|
8416
|
+
*/
|
|
7610
8417
|
provider: string;
|
|
8418
|
+
/**
|
|
8419
|
+
* Link to the account.
|
|
8420
|
+
*/
|
|
7611
8421
|
url: string;
|
|
7612
8422
|
}>;
|
|
7613
8423
|
/**
|
|
@@ -7627,9 +8437,21 @@ type ListPeopleResponses = {
|
|
|
7627
8437
|
* Of those, scored relevant.
|
|
7628
8438
|
*/
|
|
7629
8439
|
relevant: number;
|
|
8440
|
+
/**
|
|
8441
|
+
* Their matched mentions by sentiment.
|
|
8442
|
+
*/
|
|
7630
8443
|
sentiment: {
|
|
8444
|
+
/**
|
|
8445
|
+
* Scored positive.
|
|
8446
|
+
*/
|
|
7631
8447
|
positive: number;
|
|
8448
|
+
/**
|
|
8449
|
+
* Scored neutral.
|
|
8450
|
+
*/
|
|
7632
8451
|
neutral: number;
|
|
8452
|
+
/**
|
|
8453
|
+
* Scored negative.
|
|
8454
|
+
*/
|
|
7633
8455
|
negative: number;
|
|
7634
8456
|
};
|
|
7635
8457
|
/**
|
|
@@ -7645,7 +8467,13 @@ type ListPeopleResponses = {
|
|
|
7645
8467
|
* What this workspace wrote about the person.
|
|
7646
8468
|
*/
|
|
7647
8469
|
annotations: {
|
|
8470
|
+
/**
|
|
8471
|
+
* Tags your team gave them.
|
|
8472
|
+
*/
|
|
7648
8473
|
tags: Array<string>;
|
|
8474
|
+
/**
|
|
8475
|
+
* Your team's notes.
|
|
8476
|
+
*/
|
|
7649
8477
|
notes: string;
|
|
7650
8478
|
/**
|
|
7651
8479
|
* 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.
|
|
@@ -7664,7 +8492,13 @@ type ListPeopleResponses = {
|
|
|
7664
8492
|
* User id of the workspace member.
|
|
7665
8493
|
*/
|
|
7666
8494
|
id: string;
|
|
8495
|
+
/**
|
|
8496
|
+
* The member's name.
|
|
8497
|
+
*/
|
|
7667
8498
|
name: string | null;
|
|
8499
|
+
/**
|
|
8500
|
+
* The member's email.
|
|
8501
|
+
*/
|
|
7668
8502
|
email: string | null;
|
|
7669
8503
|
} | null;
|
|
7670
8504
|
/**
|
|
@@ -7701,6 +8535,10 @@ type GetPersonData = {
|
|
|
7701
8535
|
url: '/v1/people/{id}';
|
|
7702
8536
|
};
|
|
7703
8537
|
type GetPersonErrors = {
|
|
8538
|
+
/**
|
|
8539
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
8540
|
+
*/
|
|
8541
|
+
400: ErrorResponse;
|
|
7704
8542
|
/**
|
|
7705
8543
|
* Missing or invalid API key
|
|
7706
8544
|
*/
|
|
@@ -7727,6 +8565,9 @@ type UpdatePersonData = {
|
|
|
7727
8565
|
* Replaces the whole list.
|
|
7728
8566
|
*/
|
|
7729
8567
|
tags?: Array<string>;
|
|
8568
|
+
/**
|
|
8569
|
+
* Notes, up to 2,000 characters; replaces the current notes.
|
|
8570
|
+
*/
|
|
7730
8571
|
notes?: string;
|
|
7731
8572
|
/**
|
|
7732
8573
|
* true hides their posts from the feed, alerts and digests; false shows them again. Without groupId for the whole workspace; with it, for that group's keywords only.
|
|
@@ -7784,6 +8625,12 @@ type MergePeopleData = {
|
|
|
7784
8625
|
*/
|
|
7785
8626
|
into: string;
|
|
7786
8627
|
};
|
|
8628
|
+
headers?: {
|
|
8629
|
+
/**
|
|
8630
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
8631
|
+
*/
|
|
8632
|
+
'idempotency-key'?: string;
|
|
8633
|
+
};
|
|
7787
8634
|
path: {
|
|
7788
8635
|
/**
|
|
7789
8636
|
* Person id (aut_...).
|
|
@@ -7799,6 +8646,10 @@ type MergePeopleData = {
|
|
|
7799
8646
|
url: '/v1/people/{id}/merge';
|
|
7800
8647
|
};
|
|
7801
8648
|
type MergePeopleErrors = {
|
|
8649
|
+
/**
|
|
8650
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
8651
|
+
*/
|
|
8652
|
+
400: ErrorResponse;
|
|
7802
8653
|
/**
|
|
7803
8654
|
* Missing or invalid API key
|
|
7804
8655
|
*/
|
|
@@ -7818,6 +8669,12 @@ type MergePeopleResponses = {
|
|
|
7818
8669
|
type MergePeopleResponse = MergePeopleResponses[keyof MergePeopleResponses];
|
|
7819
8670
|
type SplitPersonData = {
|
|
7820
8671
|
body?: never;
|
|
8672
|
+
headers?: {
|
|
8673
|
+
/**
|
|
8674
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
8675
|
+
*/
|
|
8676
|
+
'idempotency-key'?: string;
|
|
8677
|
+
};
|
|
7821
8678
|
path: {
|
|
7822
8679
|
/**
|
|
7823
8680
|
* Person id (aut_...).
|
|
@@ -7833,6 +8690,10 @@ type SplitPersonData = {
|
|
|
7833
8690
|
url: '/v1/people/{id}/split';
|
|
7834
8691
|
};
|
|
7835
8692
|
type SplitPersonErrors = {
|
|
8693
|
+
/**
|
|
8694
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
8695
|
+
*/
|
|
8696
|
+
400: ErrorResponse;
|
|
7836
8697
|
/**
|
|
7837
8698
|
* Missing or invalid API key
|
|
7838
8699
|
*/
|
|
@@ -7867,6 +8728,10 @@ type ListPersonActivitiesData = {
|
|
|
7867
8728
|
url: '/v1/people/{id}/activities';
|
|
7868
8729
|
};
|
|
7869
8730
|
type ListPersonActivitiesErrors = {
|
|
8731
|
+
/**
|
|
8732
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
8733
|
+
*/
|
|
8734
|
+
400: ErrorResponse;
|
|
7870
8735
|
/**
|
|
7871
8736
|
* Missing or invalid API key
|
|
7872
8737
|
*/
|
|
@@ -7910,7 +8775,13 @@ type ListPersonActivitiesResponses = {
|
|
|
7910
8775
|
* User id of the workspace member.
|
|
7911
8776
|
*/
|
|
7912
8777
|
id: string;
|
|
8778
|
+
/**
|
|
8779
|
+
* The member's name.
|
|
8780
|
+
*/
|
|
7913
8781
|
name: string | null;
|
|
8782
|
+
/**
|
|
8783
|
+
* The member's email.
|
|
8784
|
+
*/
|
|
7914
8785
|
email: string | null;
|
|
7915
8786
|
} | null;
|
|
7916
8787
|
/**
|
|
@@ -8007,6 +8878,10 @@ type DeletePersonActivityData = {
|
|
|
8007
8878
|
url: '/v1/people/{id}/activities/{activityId}';
|
|
8008
8879
|
};
|
|
8009
8880
|
type DeletePersonActivityErrors = {
|
|
8881
|
+
/**
|
|
8882
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
8883
|
+
*/
|
|
8884
|
+
400: ErrorResponse;
|
|
8010
8885
|
/**
|
|
8011
8886
|
* Missing or invalid API key
|
|
8012
8887
|
*/
|
|
@@ -8061,6 +8936,10 @@ type ListSegmentsData = {
|
|
|
8061
8936
|
url: '/v1/segments';
|
|
8062
8937
|
};
|
|
8063
8938
|
type ListSegmentsErrors = {
|
|
8939
|
+
/**
|
|
8940
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
8941
|
+
*/
|
|
8942
|
+
400: ErrorResponse;
|
|
8064
8943
|
/**
|
|
8065
8944
|
* Missing or invalid API key
|
|
8066
8945
|
*/
|
|
@@ -8076,13 +8955,25 @@ type ListSegmentsResponses = {
|
|
|
8076
8955
|
* Every segment
|
|
8077
8956
|
*/
|
|
8078
8957
|
200: {
|
|
8958
|
+
/**
|
|
8959
|
+
* The segments.
|
|
8960
|
+
*/
|
|
8079
8961
|
data: Array<{
|
|
8080
8962
|
/**
|
|
8081
8963
|
* Segment id (seg_...).
|
|
8082
8964
|
*/
|
|
8083
8965
|
id: string;
|
|
8966
|
+
/**
|
|
8967
|
+
* Segment name.
|
|
8968
|
+
*/
|
|
8084
8969
|
name: string;
|
|
8970
|
+
/**
|
|
8971
|
+
* What the segment is for.
|
|
8972
|
+
*/
|
|
8085
8973
|
description: string;
|
|
8974
|
+
/**
|
|
8975
|
+
* The people filter it saves (the fields of GET /v1/people).
|
|
8976
|
+
*/
|
|
8086
8977
|
filter: {
|
|
8087
8978
|
/**
|
|
8088
8979
|
* People with an account on any of these platforms.
|
|
@@ -8148,6 +9039,18 @@ type ListSegmentsResponses = {
|
|
|
8148
9039
|
* People at any of these outreach stages.
|
|
8149
9040
|
*/
|
|
8150
9041
|
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
9042
|
+
/**
|
|
9043
|
+
* Nobody at these outreach stages.
|
|
9044
|
+
*/
|
|
9045
|
+
notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
9046
|
+
/**
|
|
9047
|
+
* Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
9048
|
+
*/
|
|
9049
|
+
notLinkHosts?: Array<string>;
|
|
9050
|
+
/**
|
|
9051
|
+
* Nobody owned by these members (user ids); "none" drops the people nobody owns.
|
|
9052
|
+
*/
|
|
9053
|
+
notOwnerIds?: Array<string>;
|
|
8151
9054
|
/**
|
|
8152
9055
|
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
|
|
8153
9056
|
*/
|
|
@@ -8185,81 +9088,797 @@ type ListSegmentsResponses = {
|
|
|
8185
9088
|
type ListSegmentsResponse = ListSegmentsResponses[keyof ListSegmentsResponses];
|
|
8186
9089
|
type CreateSegmentData = {
|
|
8187
9090
|
body: {
|
|
9091
|
+
/**
|
|
9092
|
+
* Segment name, unique in its scope.
|
|
9093
|
+
*/
|
|
8188
9094
|
name: string;
|
|
9095
|
+
/**
|
|
9096
|
+
* What the segment is for.
|
|
9097
|
+
*/
|
|
8189
9098
|
description?: string;
|
|
9099
|
+
/**
|
|
9100
|
+
* The people filter (the fields of GET /v1/people).
|
|
9101
|
+
*/
|
|
8190
9102
|
filter?: {
|
|
8191
9103
|
/**
|
|
8192
|
-
* People with an account on any of these platforms.
|
|
9104
|
+
* People with an account on any of these platforms.
|
|
9105
|
+
*/
|
|
9106
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9107
|
+
/**
|
|
9108
|
+
* People carrying any of these tags.
|
|
9109
|
+
*/
|
|
9110
|
+
tags?: Array<string>;
|
|
9111
|
+
/**
|
|
9112
|
+
* At least this many followers. Unknown reach never matches.
|
|
9113
|
+
*/
|
|
9114
|
+
minFollowers?: number;
|
|
9115
|
+
/**
|
|
9116
|
+
* At most this many followers. Unknown reach never matches.
|
|
9117
|
+
*/
|
|
9118
|
+
maxFollowers?: number;
|
|
9119
|
+
/**
|
|
9120
|
+
* At least this many matched mentions.
|
|
9121
|
+
*/
|
|
9122
|
+
minMentions?: number;
|
|
9123
|
+
/**
|
|
9124
|
+
* At least this many negative mentions.
|
|
9125
|
+
*/
|
|
9126
|
+
minNegative?: number;
|
|
9127
|
+
/**
|
|
9128
|
+
* At least one mention carrying any of these intents.
|
|
9129
|
+
*/
|
|
9130
|
+
intents?: Array<string>;
|
|
9131
|
+
/**
|
|
9132
|
+
* Mentioned a keyword of any of these kinds.
|
|
9133
|
+
*/
|
|
9134
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9135
|
+
/**
|
|
9136
|
+
* Never mentioned a keyword of these kinds.
|
|
9137
|
+
*/
|
|
9138
|
+
neverKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9139
|
+
/**
|
|
9140
|
+
* Nobody with an account on these platforms.
|
|
9141
|
+
*/
|
|
9142
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9143
|
+
/**
|
|
9144
|
+
* Nobody carrying any of these tags.
|
|
9145
|
+
*/
|
|
9146
|
+
notTags?: Array<string>;
|
|
9147
|
+
/**
|
|
9148
|
+
* Nobody whose mentions carry any of these intents.
|
|
9149
|
+
*/
|
|
9150
|
+
notIntents?: Array<string>;
|
|
9151
|
+
/**
|
|
9152
|
+
* First seen within this many days.
|
|
9153
|
+
*/
|
|
9154
|
+
newSinceDays?: number;
|
|
9155
|
+
/**
|
|
9156
|
+
* At least one mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
9157
|
+
*/
|
|
9158
|
+
linkHosts?: Array<string>;
|
|
9159
|
+
/**
|
|
9160
|
+
* true: only muted people; false: only unmuted.
|
|
9161
|
+
*/
|
|
9162
|
+
muted?: boolean;
|
|
9163
|
+
/**
|
|
9164
|
+
* People at any of these outreach stages.
|
|
9165
|
+
*/
|
|
9166
|
+
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
9167
|
+
/**
|
|
9168
|
+
* Nobody at these outreach stages.
|
|
9169
|
+
*/
|
|
9170
|
+
notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
9171
|
+
/**
|
|
9172
|
+
* Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
9173
|
+
*/
|
|
9174
|
+
notLinkHosts?: Array<string>;
|
|
9175
|
+
/**
|
|
9176
|
+
* Nobody owned by these members (user ids); "none" drops the people nobody owns.
|
|
9177
|
+
*/
|
|
9178
|
+
notOwnerIds?: Array<string>;
|
|
9179
|
+
/**
|
|
9180
|
+
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
|
|
9181
|
+
*/
|
|
9182
|
+
automated?: boolean;
|
|
9183
|
+
/**
|
|
9184
|
+
* People owned by any of these members (user ids); "none" matches people nobody owns.
|
|
9185
|
+
*/
|
|
9186
|
+
ownerIds?: Array<string>;
|
|
9187
|
+
};
|
|
9188
|
+
};
|
|
9189
|
+
headers?: {
|
|
9190
|
+
/**
|
|
9191
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
9192
|
+
*/
|
|
9193
|
+
'idempotency-key'?: string;
|
|
9194
|
+
};
|
|
9195
|
+
path?: never;
|
|
9196
|
+
query?: {
|
|
9197
|
+
/**
|
|
9198
|
+
* 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.
|
|
9199
|
+
*/
|
|
9200
|
+
groupId?: string;
|
|
9201
|
+
};
|
|
9202
|
+
url: '/v1/segments';
|
|
9203
|
+
};
|
|
9204
|
+
type CreateSegmentErrors = {
|
|
9205
|
+
/**
|
|
9206
|
+
* Invalid body
|
|
9207
|
+
*/
|
|
9208
|
+
400: ErrorResponse;
|
|
9209
|
+
/**
|
|
9210
|
+
* Missing or invalid API key
|
|
9211
|
+
*/
|
|
9212
|
+
401: ErrorResponse;
|
|
9213
|
+
/**
|
|
9214
|
+
* No such group
|
|
9215
|
+
*/
|
|
9216
|
+
404: ErrorResponse;
|
|
9217
|
+
/**
|
|
9218
|
+
* A segment with this name already exists in this scope
|
|
9219
|
+
*/
|
|
9220
|
+
409: ErrorResponse;
|
|
9221
|
+
};
|
|
9222
|
+
type CreateSegmentError = CreateSegmentErrors[keyof CreateSegmentErrors];
|
|
9223
|
+
type CreateSegmentResponses = {
|
|
9224
|
+
/**
|
|
9225
|
+
* The saved segment, with its current size
|
|
9226
|
+
*/
|
|
9227
|
+
201: Segment;
|
|
9228
|
+
};
|
|
9229
|
+
type CreateSegmentResponse = CreateSegmentResponses[keyof CreateSegmentResponses];
|
|
9230
|
+
type DeleteSegmentData = {
|
|
9231
|
+
body?: never;
|
|
9232
|
+
path: {
|
|
9233
|
+
/**
|
|
9234
|
+
* Segment id (seg_...).
|
|
9235
|
+
*/
|
|
9236
|
+
id: string;
|
|
9237
|
+
};
|
|
9238
|
+
query?: {
|
|
9239
|
+
/**
|
|
9240
|
+
* 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.
|
|
9241
|
+
*/
|
|
9242
|
+
groupId?: string;
|
|
9243
|
+
};
|
|
9244
|
+
url: '/v1/segments/{id}';
|
|
9245
|
+
};
|
|
9246
|
+
type DeleteSegmentErrors = {
|
|
9247
|
+
/**
|
|
9248
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
9249
|
+
*/
|
|
9250
|
+
400: ErrorResponse;
|
|
9251
|
+
/**
|
|
9252
|
+
* Missing or invalid API key
|
|
9253
|
+
*/
|
|
9254
|
+
401: ErrorResponse;
|
|
9255
|
+
/**
|
|
9256
|
+
* No such segment in this scope, or no such group
|
|
9257
|
+
*/
|
|
9258
|
+
404: ErrorResponse;
|
|
9259
|
+
};
|
|
9260
|
+
type DeleteSegmentError = DeleteSegmentErrors[keyof DeleteSegmentErrors];
|
|
9261
|
+
type DeleteSegmentResponses = {
|
|
9262
|
+
/**
|
|
9263
|
+
* Deleted
|
|
9264
|
+
*/
|
|
9265
|
+
204: void;
|
|
9266
|
+
};
|
|
9267
|
+
type DeleteSegmentResponse = DeleteSegmentResponses[keyof DeleteSegmentResponses];
|
|
9268
|
+
type GetSegmentData = {
|
|
9269
|
+
body?: never;
|
|
9270
|
+
path: {
|
|
9271
|
+
/**
|
|
9272
|
+
* Segment id (seg_...).
|
|
9273
|
+
*/
|
|
9274
|
+
id: string;
|
|
9275
|
+
};
|
|
9276
|
+
query?: {
|
|
9277
|
+
/**
|
|
9278
|
+
* 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.
|
|
9279
|
+
*/
|
|
9280
|
+
groupId?: string;
|
|
9281
|
+
};
|
|
9282
|
+
url: '/v1/segments/{id}';
|
|
9283
|
+
};
|
|
9284
|
+
type GetSegmentErrors = {
|
|
9285
|
+
/**
|
|
9286
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
9287
|
+
*/
|
|
9288
|
+
400: ErrorResponse;
|
|
9289
|
+
/**
|
|
9290
|
+
* Missing or invalid API key
|
|
9291
|
+
*/
|
|
9292
|
+
401: ErrorResponse;
|
|
9293
|
+
/**
|
|
9294
|
+
* No such segment in this scope, or no such group
|
|
9295
|
+
*/
|
|
9296
|
+
404: ErrorResponse;
|
|
9297
|
+
};
|
|
9298
|
+
type GetSegmentError = GetSegmentErrors[keyof GetSegmentErrors];
|
|
9299
|
+
type GetSegmentResponses = {
|
|
9300
|
+
/**
|
|
9301
|
+
* One segment, with its current size
|
|
9302
|
+
*/
|
|
9303
|
+
200: Segment;
|
|
9304
|
+
};
|
|
9305
|
+
type GetSegmentResponse = GetSegmentResponses[keyof GetSegmentResponses];
|
|
9306
|
+
type UpdateSegmentData = {
|
|
9307
|
+
/**
|
|
9308
|
+
* Omitted fields are untouched.
|
|
9309
|
+
*/
|
|
9310
|
+
body: {
|
|
9311
|
+
/**
|
|
9312
|
+
* Segment name, unique in its scope.
|
|
9313
|
+
*/
|
|
9314
|
+
name?: string;
|
|
9315
|
+
/**
|
|
9316
|
+
* What the segment is for.
|
|
9317
|
+
*/
|
|
9318
|
+
description?: string;
|
|
9319
|
+
/**
|
|
9320
|
+
* Replaces the whole filter.
|
|
9321
|
+
*/
|
|
9322
|
+
filter?: {
|
|
9323
|
+
/**
|
|
9324
|
+
* People with an account on any of these platforms.
|
|
9325
|
+
*/
|
|
9326
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9327
|
+
/**
|
|
9328
|
+
* People carrying any of these tags.
|
|
9329
|
+
*/
|
|
9330
|
+
tags?: Array<string>;
|
|
9331
|
+
/**
|
|
9332
|
+
* At least this many followers. Unknown reach never matches.
|
|
9333
|
+
*/
|
|
9334
|
+
minFollowers?: number;
|
|
9335
|
+
/**
|
|
9336
|
+
* At most this many followers. Unknown reach never matches.
|
|
9337
|
+
*/
|
|
9338
|
+
maxFollowers?: number;
|
|
9339
|
+
/**
|
|
9340
|
+
* At least this many matched mentions.
|
|
9341
|
+
*/
|
|
9342
|
+
minMentions?: number;
|
|
9343
|
+
/**
|
|
9344
|
+
* At least this many negative mentions.
|
|
9345
|
+
*/
|
|
9346
|
+
minNegative?: number;
|
|
9347
|
+
/**
|
|
9348
|
+
* At least one mention carrying any of these intents.
|
|
9349
|
+
*/
|
|
9350
|
+
intents?: Array<string>;
|
|
9351
|
+
/**
|
|
9352
|
+
* Mentioned a keyword of any of these kinds.
|
|
9353
|
+
*/
|
|
9354
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9355
|
+
/**
|
|
9356
|
+
* Never mentioned a keyword of these kinds.
|
|
9357
|
+
*/
|
|
9358
|
+
neverKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9359
|
+
/**
|
|
9360
|
+
* Nobody with an account on these platforms.
|
|
9361
|
+
*/
|
|
9362
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9363
|
+
/**
|
|
9364
|
+
* Nobody carrying any of these tags.
|
|
9365
|
+
*/
|
|
9366
|
+
notTags?: Array<string>;
|
|
9367
|
+
/**
|
|
9368
|
+
* Nobody whose mentions carry any of these intents.
|
|
9369
|
+
*/
|
|
9370
|
+
notIntents?: Array<string>;
|
|
9371
|
+
/**
|
|
9372
|
+
* First seen within this many days.
|
|
9373
|
+
*/
|
|
9374
|
+
newSinceDays?: number;
|
|
9375
|
+
/**
|
|
9376
|
+
* At least one mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
9377
|
+
*/
|
|
9378
|
+
linkHosts?: Array<string>;
|
|
9379
|
+
/**
|
|
9380
|
+
* true: only muted people; false: only unmuted.
|
|
9381
|
+
*/
|
|
9382
|
+
muted?: boolean;
|
|
9383
|
+
/**
|
|
9384
|
+
* People at any of these outreach stages.
|
|
9385
|
+
*/
|
|
9386
|
+
stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
9387
|
+
/**
|
|
9388
|
+
* Nobody at these outreach stages.
|
|
9389
|
+
*/
|
|
9390
|
+
notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
|
|
9391
|
+
/**
|
|
9392
|
+
* Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
|
|
9393
|
+
*/
|
|
9394
|
+
notLinkHosts?: Array<string>;
|
|
9395
|
+
/**
|
|
9396
|
+
* Nobody owned by these members (user ids); "none" drops the people nobody owns.
|
|
9397
|
+
*/
|
|
9398
|
+
notOwnerIds?: Array<string>;
|
|
9399
|
+
/**
|
|
9400
|
+
* true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
|
|
9401
|
+
*/
|
|
9402
|
+
automated?: boolean;
|
|
9403
|
+
/**
|
|
9404
|
+
* People owned by any of these members (user ids); "none" matches people nobody owns.
|
|
9405
|
+
*/
|
|
9406
|
+
ownerIds?: Array<string>;
|
|
9407
|
+
};
|
|
9408
|
+
};
|
|
9409
|
+
path: {
|
|
9410
|
+
/**
|
|
9411
|
+
* Segment id (seg_...).
|
|
9412
|
+
*/
|
|
9413
|
+
id: string;
|
|
9414
|
+
};
|
|
9415
|
+
query?: {
|
|
9416
|
+
/**
|
|
9417
|
+
* 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.
|
|
9418
|
+
*/
|
|
9419
|
+
groupId?: string;
|
|
9420
|
+
};
|
|
9421
|
+
url: '/v1/segments/{id}';
|
|
9422
|
+
};
|
|
9423
|
+
type UpdateSegmentErrors = {
|
|
9424
|
+
/**
|
|
9425
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
9426
|
+
*/
|
|
9427
|
+
400: ErrorResponse;
|
|
9428
|
+
/**
|
|
9429
|
+
* Missing or invalid API key
|
|
9430
|
+
*/
|
|
9431
|
+
401: ErrorResponse;
|
|
9432
|
+
/**
|
|
9433
|
+
* No such segment in this scope, or no such group
|
|
9434
|
+
*/
|
|
9435
|
+
404: ErrorResponse;
|
|
9436
|
+
/**
|
|
9437
|
+
* A segment with this name already exists in this scope
|
|
9438
|
+
*/
|
|
9439
|
+
409: ErrorResponse;
|
|
9440
|
+
};
|
|
9441
|
+
type UpdateSegmentError = UpdateSegmentErrors[keyof UpdateSegmentErrors];
|
|
9442
|
+
type UpdateSegmentResponses = {
|
|
9443
|
+
/**
|
|
9444
|
+
* The updated segment
|
|
9445
|
+
*/
|
|
9446
|
+
200: Segment;
|
|
9447
|
+
};
|
|
9448
|
+
type UpdateSegmentResponse = UpdateSegmentResponses[keyof UpdateSegmentResponses];
|
|
9449
|
+
type ListViewsData = {
|
|
9450
|
+
body?: never;
|
|
9451
|
+
path?: never;
|
|
9452
|
+
query?: never;
|
|
9453
|
+
url: '/v1/views';
|
|
9454
|
+
};
|
|
9455
|
+
type ListViewsErrors = {
|
|
9456
|
+
/**
|
|
9457
|
+
* Missing or invalid API key
|
|
9458
|
+
*/
|
|
9459
|
+
401: ErrorResponse;
|
|
9460
|
+
};
|
|
9461
|
+
type ListViewsError = ListViewsErrors[keyof ListViewsErrors];
|
|
9462
|
+
type ListViewsResponses = {
|
|
9463
|
+
/**
|
|
9464
|
+
* Saved views
|
|
9465
|
+
*/
|
|
9466
|
+
200: {
|
|
9467
|
+
/**
|
|
9468
|
+
* Saved views, oldest first.
|
|
9469
|
+
*/
|
|
9470
|
+
data: Array<{
|
|
9471
|
+
/**
|
|
9472
|
+
* View id (vw_...).
|
|
9473
|
+
*/
|
|
9474
|
+
id: string;
|
|
9475
|
+
/**
|
|
9476
|
+
* View name.
|
|
9477
|
+
*/
|
|
9478
|
+
name: string;
|
|
9479
|
+
/**
|
|
9480
|
+
* What the view is for.
|
|
9481
|
+
*/
|
|
9482
|
+
description: string;
|
|
9483
|
+
/**
|
|
9484
|
+
* The mentions filter it saves (the fields of GET /v1/mentions).
|
|
9485
|
+
*/
|
|
9486
|
+
filter: {
|
|
9487
|
+
/**
|
|
9488
|
+
* Substring in the post text or the author's name.
|
|
9489
|
+
*/
|
|
9490
|
+
q?: string;
|
|
9491
|
+
/**
|
|
9492
|
+
* Only matches of any of these keywords.
|
|
9493
|
+
*/
|
|
9494
|
+
keywordIds?: Array<string>;
|
|
9495
|
+
/**
|
|
9496
|
+
* Never matches of these keywords.
|
|
9497
|
+
*/
|
|
9498
|
+
notKeywordIds?: Array<string>;
|
|
9499
|
+
/**
|
|
9500
|
+
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
9501
|
+
*/
|
|
9502
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9503
|
+
/**
|
|
9504
|
+
* Never matches of keywords of these kinds.
|
|
9505
|
+
*/
|
|
9506
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9507
|
+
/**
|
|
9508
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
9509
|
+
*/
|
|
9510
|
+
groupIds?: Array<string>;
|
|
9511
|
+
/**
|
|
9512
|
+
* Never matches of keywords in these groups.
|
|
9513
|
+
*/
|
|
9514
|
+
notGroupIds?: Array<string>;
|
|
9515
|
+
/**
|
|
9516
|
+
* Only posts from any of these platforms.
|
|
9517
|
+
*/
|
|
9518
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9519
|
+
/**
|
|
9520
|
+
* Never posts from these platforms.
|
|
9521
|
+
*/
|
|
9522
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9523
|
+
/**
|
|
9524
|
+
* Only mentions in this status: open, ignored, done.
|
|
9525
|
+
*/
|
|
9526
|
+
status?: 'open' | 'ignored' | 'done';
|
|
9527
|
+
/**
|
|
9528
|
+
* true: only mentions the classifier scored relevant; false: only the rest.
|
|
9529
|
+
*/
|
|
9530
|
+
relevant?: boolean;
|
|
9531
|
+
/**
|
|
9532
|
+
* Only mentions scored at least this.
|
|
9533
|
+
*/
|
|
9534
|
+
minRelevance?: number;
|
|
9535
|
+
/**
|
|
9536
|
+
* Only mentions whose classifier confidence is at least this.
|
|
9537
|
+
*/
|
|
9538
|
+
minConfidence?: number;
|
|
9539
|
+
/**
|
|
9540
|
+
* Only these sentiments.
|
|
9541
|
+
*/
|
|
9542
|
+
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
9543
|
+
/**
|
|
9544
|
+
* Never these sentiments; an unscored mention still passes.
|
|
9545
|
+
*/
|
|
9546
|
+
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
9547
|
+
/**
|
|
9548
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
9549
|
+
*/
|
|
9550
|
+
intents?: Array<string>;
|
|
9551
|
+
/**
|
|
9552
|
+
* Never mentions carrying these tags.
|
|
9553
|
+
*/
|
|
9554
|
+
notIntents?: Array<string>;
|
|
9555
|
+
/**
|
|
9556
|
+
* true: only posts that read as machine-made; false: only the rest.
|
|
9557
|
+
*/
|
|
9558
|
+
automated?: boolean;
|
|
9559
|
+
/**
|
|
9560
|
+
* Only posts in any of these languages (ISO 639-1).
|
|
9561
|
+
*/
|
|
9562
|
+
languages?: Array<string>;
|
|
9563
|
+
/**
|
|
9564
|
+
* Never posts in these languages; an unknown language still passes.
|
|
9565
|
+
*/
|
|
9566
|
+
notLanguages?: Array<string>;
|
|
9567
|
+
/**
|
|
9568
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
9569
|
+
*/
|
|
9570
|
+
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'>;
|
|
9571
|
+
/**
|
|
9572
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
9573
|
+
*/
|
|
9574
|
+
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'>;
|
|
9575
|
+
/**
|
|
9576
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
9577
|
+
*/
|
|
9578
|
+
organization?: boolean;
|
|
9579
|
+
/**
|
|
9580
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
9581
|
+
*/
|
|
9582
|
+
tags?: Array<string>;
|
|
9583
|
+
/**
|
|
9584
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
9585
|
+
*/
|
|
9586
|
+
notTags?: Array<string>;
|
|
9587
|
+
/**
|
|
9588
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
9589
|
+
*/
|
|
9590
|
+
labels?: Array<string>;
|
|
9591
|
+
/**
|
|
9592
|
+
* Never mentions carrying any of these labels.
|
|
9593
|
+
*/
|
|
9594
|
+
notLabels?: Array<string>;
|
|
9595
|
+
/**
|
|
9596
|
+
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
9597
|
+
*/
|
|
9598
|
+
linkHosts?: Array<string>;
|
|
9599
|
+
/**
|
|
9600
|
+
* Never posts linking to these hosts.
|
|
9601
|
+
*/
|
|
9602
|
+
notLinkHosts?: Array<string>;
|
|
9603
|
+
/**
|
|
9604
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
9605
|
+
*/
|
|
9606
|
+
subreddits?: Array<string>;
|
|
9607
|
+
/**
|
|
9608
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
9609
|
+
*/
|
|
9610
|
+
notSubreddits?: Array<string>;
|
|
9611
|
+
/**
|
|
9612
|
+
* Only authors with at least this many followers; unknown reach never passes.
|
|
9613
|
+
*/
|
|
9614
|
+
minFollowers?: number;
|
|
9615
|
+
/**
|
|
9616
|
+
* Only authors with at most this many followers; unknown reach never passes.
|
|
9617
|
+
*/
|
|
9618
|
+
maxFollowers?: number;
|
|
9619
|
+
/**
|
|
9620
|
+
* true: only replies and comments; false: only top-level posts.
|
|
9621
|
+
*/
|
|
9622
|
+
isReply?: boolean;
|
|
9623
|
+
/**
|
|
9624
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
9625
|
+
*/
|
|
9626
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
9627
|
+
/**
|
|
9628
|
+
* Never these authors: display names, handles or profile URLs.
|
|
9629
|
+
*/
|
|
9630
|
+
notAuthors?: Array<string>;
|
|
9631
|
+
/**
|
|
9632
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
9633
|
+
*/
|
|
9634
|
+
excludeAuthors?: Array<string>;
|
|
9635
|
+
/**
|
|
9636
|
+
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
9637
|
+
*/
|
|
9638
|
+
ratings?: Array<number>;
|
|
9639
|
+
/**
|
|
9640
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
9641
|
+
*/
|
|
9642
|
+
notRatings?: Array<number>;
|
|
9643
|
+
/**
|
|
9644
|
+
* 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.
|
|
9645
|
+
*/
|
|
9646
|
+
minLikes?: number;
|
|
9647
|
+
/**
|
|
9648
|
+
* 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.
|
|
9649
|
+
*/
|
|
9650
|
+
minReposts?: number;
|
|
9651
|
+
/**
|
|
9652
|
+
* 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.
|
|
9653
|
+
*/
|
|
9654
|
+
minReplies?: number;
|
|
9655
|
+
/**
|
|
9656
|
+
* 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.
|
|
9657
|
+
*/
|
|
9658
|
+
minQuotes?: number;
|
|
9659
|
+
/**
|
|
9660
|
+
* 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.
|
|
9661
|
+
*/
|
|
9662
|
+
minViews?: number;
|
|
9663
|
+
/**
|
|
9664
|
+
* 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.
|
|
9665
|
+
*/
|
|
9666
|
+
minBookmarks?: number;
|
|
9667
|
+
/**
|
|
9668
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
9669
|
+
*/
|
|
9670
|
+
anyOf?: Array<FilterGroup>;
|
|
9671
|
+
};
|
|
9672
|
+
/**
|
|
9673
|
+
* ISO 8601 timestamp, UTC.
|
|
9674
|
+
*/
|
|
9675
|
+
createdAt: string;
|
|
9676
|
+
/**
|
|
9677
|
+
* ISO 8601 timestamp, UTC.
|
|
9678
|
+
*/
|
|
9679
|
+
updatedAt: string;
|
|
9680
|
+
}>;
|
|
9681
|
+
};
|
|
9682
|
+
};
|
|
9683
|
+
type ListViewsResponse = ListViewsResponses[keyof ListViewsResponses];
|
|
9684
|
+
type CreateViewData = {
|
|
9685
|
+
body: {
|
|
9686
|
+
/**
|
|
9687
|
+
* Unique per workspace, case-insensitive.
|
|
9688
|
+
*/
|
|
9689
|
+
name: string;
|
|
9690
|
+
/**
|
|
9691
|
+
* What the view is for, shown under its name.
|
|
9692
|
+
*/
|
|
9693
|
+
description?: string;
|
|
9694
|
+
/**
|
|
9695
|
+
* The filter; empty selects every mention.
|
|
9696
|
+
*/
|
|
9697
|
+
filter?: {
|
|
9698
|
+
/**
|
|
9699
|
+
* Substring in the post text or the author's name.
|
|
9700
|
+
*/
|
|
9701
|
+
q?: string;
|
|
9702
|
+
/**
|
|
9703
|
+
* Only matches of any of these keywords.
|
|
9704
|
+
*/
|
|
9705
|
+
keywordIds?: Array<string>;
|
|
9706
|
+
/**
|
|
9707
|
+
* Never matches of these keywords.
|
|
9708
|
+
*/
|
|
9709
|
+
notKeywordIds?: Array<string>;
|
|
9710
|
+
/**
|
|
9711
|
+
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
9712
|
+
*/
|
|
9713
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9714
|
+
/**
|
|
9715
|
+
* Never matches of keywords of these kinds.
|
|
9716
|
+
*/
|
|
9717
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9718
|
+
/**
|
|
9719
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
9720
|
+
*/
|
|
9721
|
+
groupIds?: Array<string>;
|
|
9722
|
+
/**
|
|
9723
|
+
* Never matches of keywords in these groups.
|
|
9724
|
+
*/
|
|
9725
|
+
notGroupIds?: Array<string>;
|
|
9726
|
+
/**
|
|
9727
|
+
* Only posts from any of these platforms.
|
|
9728
|
+
*/
|
|
9729
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9730
|
+
/**
|
|
9731
|
+
* Never posts from these platforms.
|
|
9732
|
+
*/
|
|
9733
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9734
|
+
/**
|
|
9735
|
+
* Only mentions in this status: open, ignored, done.
|
|
9736
|
+
*/
|
|
9737
|
+
status?: 'open' | 'ignored' | 'done';
|
|
9738
|
+
/**
|
|
9739
|
+
* true: only mentions the classifier scored relevant; false: only the rest.
|
|
9740
|
+
*/
|
|
9741
|
+
relevant?: boolean;
|
|
9742
|
+
/**
|
|
9743
|
+
* Only mentions scored at least this.
|
|
9744
|
+
*/
|
|
9745
|
+
minRelevance?: number;
|
|
9746
|
+
/**
|
|
9747
|
+
* Only mentions whose classifier confidence is at least this.
|
|
9748
|
+
*/
|
|
9749
|
+
minConfidence?: number;
|
|
9750
|
+
/**
|
|
9751
|
+
* Only these sentiments.
|
|
9752
|
+
*/
|
|
9753
|
+
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
9754
|
+
/**
|
|
9755
|
+
* Never these sentiments; an unscored mention still passes.
|
|
9756
|
+
*/
|
|
9757
|
+
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
9758
|
+
/**
|
|
9759
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
9760
|
+
*/
|
|
9761
|
+
intents?: Array<string>;
|
|
9762
|
+
/**
|
|
9763
|
+
* Never mentions carrying these tags.
|
|
9764
|
+
*/
|
|
9765
|
+
notIntents?: Array<string>;
|
|
9766
|
+
/**
|
|
9767
|
+
* true: only posts that read as machine-made; false: only the rest.
|
|
9768
|
+
*/
|
|
9769
|
+
automated?: boolean;
|
|
9770
|
+
/**
|
|
9771
|
+
* Only posts in any of these languages (ISO 639-1).
|
|
9772
|
+
*/
|
|
9773
|
+
languages?: Array<string>;
|
|
9774
|
+
/**
|
|
9775
|
+
* Never posts in these languages; an unknown language still passes.
|
|
9776
|
+
*/
|
|
9777
|
+
notLanguages?: Array<string>;
|
|
9778
|
+
/**
|
|
9779
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
9780
|
+
*/
|
|
9781
|
+
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'>;
|
|
9782
|
+
/**
|
|
9783
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
9784
|
+
*/
|
|
9785
|
+
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'>;
|
|
9786
|
+
/**
|
|
9787
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
9788
|
+
*/
|
|
9789
|
+
organization?: boolean;
|
|
9790
|
+
/**
|
|
9791
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
9792
|
+
*/
|
|
9793
|
+
tags?: Array<string>;
|
|
9794
|
+
/**
|
|
9795
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
8193
9796
|
*/
|
|
8194
|
-
|
|
9797
|
+
notTags?: Array<string>;
|
|
8195
9798
|
/**
|
|
8196
|
-
*
|
|
9799
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
8197
9800
|
*/
|
|
8198
|
-
|
|
9801
|
+
labels?: Array<string>;
|
|
8199
9802
|
/**
|
|
8200
|
-
*
|
|
9803
|
+
* Never mentions carrying any of these labels.
|
|
8201
9804
|
*/
|
|
8202
|
-
|
|
9805
|
+
notLabels?: Array<string>;
|
|
8203
9806
|
/**
|
|
8204
|
-
*
|
|
9807
|
+
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
8205
9808
|
*/
|
|
8206
|
-
|
|
9809
|
+
linkHosts?: Array<string>;
|
|
8207
9810
|
/**
|
|
8208
|
-
*
|
|
9811
|
+
* Never posts linking to these hosts.
|
|
8209
9812
|
*/
|
|
8210
|
-
|
|
9813
|
+
notLinkHosts?: Array<string>;
|
|
8211
9814
|
/**
|
|
8212
|
-
*
|
|
9815
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
8213
9816
|
*/
|
|
8214
|
-
|
|
9817
|
+
subreddits?: Array<string>;
|
|
8215
9818
|
/**
|
|
8216
|
-
*
|
|
9819
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
8217
9820
|
*/
|
|
8218
|
-
|
|
9821
|
+
notSubreddits?: Array<string>;
|
|
8219
9822
|
/**
|
|
8220
|
-
*
|
|
9823
|
+
* Only authors with at least this many followers; unknown reach never passes.
|
|
8221
9824
|
*/
|
|
8222
|
-
|
|
9825
|
+
minFollowers?: number;
|
|
8223
9826
|
/**
|
|
8224
|
-
*
|
|
9827
|
+
* Only authors with at most this many followers; unknown reach never passes.
|
|
8225
9828
|
*/
|
|
8226
|
-
|
|
9829
|
+
maxFollowers?: number;
|
|
8227
9830
|
/**
|
|
8228
|
-
*
|
|
9831
|
+
* true: only replies and comments; false: only top-level posts.
|
|
8229
9832
|
*/
|
|
8230
|
-
|
|
9833
|
+
isReply?: boolean;
|
|
8231
9834
|
/**
|
|
8232
|
-
*
|
|
9835
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
8233
9836
|
*/
|
|
8234
|
-
|
|
9837
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
8235
9838
|
/**
|
|
8236
|
-
*
|
|
9839
|
+
* Never these authors: display names, handles or profile URLs.
|
|
8237
9840
|
*/
|
|
8238
|
-
|
|
9841
|
+
notAuthors?: Array<string>;
|
|
8239
9842
|
/**
|
|
8240
|
-
*
|
|
9843
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
8241
9844
|
*/
|
|
8242
|
-
|
|
9845
|
+
excludeAuthors?: Array<string>;
|
|
8243
9846
|
/**
|
|
8244
|
-
*
|
|
9847
|
+
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
8245
9848
|
*/
|
|
8246
|
-
|
|
9849
|
+
ratings?: Array<number>;
|
|
8247
9850
|
/**
|
|
8248
|
-
*
|
|
9851
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
8249
9852
|
*/
|
|
8250
|
-
|
|
9853
|
+
notRatings?: Array<number>;
|
|
8251
9854
|
/**
|
|
8252
|
-
*
|
|
9855
|
+
* 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.
|
|
8253
9856
|
*/
|
|
8254
|
-
|
|
9857
|
+
minLikes?: number;
|
|
8255
9858
|
/**
|
|
8256
|
-
*
|
|
9859
|
+
* 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.
|
|
8257
9860
|
*/
|
|
8258
|
-
|
|
9861
|
+
minReposts?: number;
|
|
8259
9862
|
/**
|
|
8260
|
-
*
|
|
9863
|
+
* 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.
|
|
8261
9864
|
*/
|
|
8262
|
-
|
|
9865
|
+
minReplies?: number;
|
|
9866
|
+
/**
|
|
9867
|
+
* 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.
|
|
9868
|
+
*/
|
|
9869
|
+
minQuotes?: number;
|
|
9870
|
+
/**
|
|
9871
|
+
* 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.
|
|
9872
|
+
*/
|
|
9873
|
+
minViews?: number;
|
|
9874
|
+
/**
|
|
9875
|
+
* 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.
|
|
9876
|
+
*/
|
|
9877
|
+
minBookmarks?: number;
|
|
9878
|
+
/**
|
|
9879
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
9880
|
+
*/
|
|
9881
|
+
anyOf?: Array<FilterGroup>;
|
|
8263
9882
|
};
|
|
8264
9883
|
};
|
|
8265
9884
|
headers?: {
|
|
@@ -8269,17 +9888,12 @@ type CreateSegmentData = {
|
|
|
8269
9888
|
'idempotency-key'?: string;
|
|
8270
9889
|
};
|
|
8271
9890
|
path?: never;
|
|
8272
|
-
query?:
|
|
8273
|
-
|
|
8274
|
-
* 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.
|
|
8275
|
-
*/
|
|
8276
|
-
groupId?: string;
|
|
8277
|
-
};
|
|
8278
|
-
url: '/v1/segments';
|
|
9891
|
+
query?: never;
|
|
9892
|
+
url: '/v1/views';
|
|
8279
9893
|
};
|
|
8280
|
-
type
|
|
9894
|
+
type CreateViewErrors = {
|
|
8281
9895
|
/**
|
|
8282
|
-
* Invalid
|
|
9896
|
+
* Invalid filter (an empty anyOf group, for one), or filter_too_complex: more values than one query can carry
|
|
8283
9897
|
*/
|
|
8284
9898
|
400: ErrorResponse;
|
|
8285
9899
|
/**
|
|
@@ -8287,239 +9901,348 @@ type CreateSegmentErrors = {
|
|
|
8287
9901
|
*/
|
|
8288
9902
|
401: ErrorResponse;
|
|
8289
9903
|
/**
|
|
8290
|
-
*
|
|
8291
|
-
*/
|
|
8292
|
-
404: ErrorResponse;
|
|
8293
|
-
/**
|
|
8294
|
-
* A segment with this name already exists in this scope
|
|
9904
|
+
* A view with that name already exists (duplicate_view)
|
|
8295
9905
|
*/
|
|
8296
9906
|
409: ErrorResponse;
|
|
8297
9907
|
};
|
|
8298
|
-
type
|
|
8299
|
-
type
|
|
9908
|
+
type CreateViewError = CreateViewErrors[keyof CreateViewErrors];
|
|
9909
|
+
type CreateViewResponses = {
|
|
8300
9910
|
/**
|
|
8301
|
-
* The saved
|
|
9911
|
+
* The saved view
|
|
8302
9912
|
*/
|
|
8303
|
-
201:
|
|
9913
|
+
201: View;
|
|
8304
9914
|
};
|
|
8305
|
-
type
|
|
8306
|
-
type
|
|
9915
|
+
type CreateViewResponse = CreateViewResponses[keyof CreateViewResponses];
|
|
9916
|
+
type DeleteViewData = {
|
|
8307
9917
|
body?: never;
|
|
8308
9918
|
path: {
|
|
8309
9919
|
/**
|
|
8310
|
-
*
|
|
9920
|
+
* View id (vw_...).
|
|
8311
9921
|
*/
|
|
8312
9922
|
id: string;
|
|
8313
9923
|
};
|
|
8314
|
-
query?:
|
|
8315
|
-
|
|
8316
|
-
* 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.
|
|
8317
|
-
*/
|
|
8318
|
-
groupId?: string;
|
|
8319
|
-
};
|
|
8320
|
-
url: '/v1/segments/{id}';
|
|
9924
|
+
query?: never;
|
|
9925
|
+
url: '/v1/views/{id}';
|
|
8321
9926
|
};
|
|
8322
|
-
type
|
|
9927
|
+
type DeleteViewErrors = {
|
|
8323
9928
|
/**
|
|
8324
9929
|
* Missing or invalid API key
|
|
8325
9930
|
*/
|
|
8326
9931
|
401: ErrorResponse;
|
|
8327
9932
|
/**
|
|
8328
|
-
* No such
|
|
9933
|
+
* No such view in this workspace
|
|
8329
9934
|
*/
|
|
8330
9935
|
404: ErrorResponse;
|
|
8331
9936
|
};
|
|
8332
|
-
type
|
|
8333
|
-
type
|
|
9937
|
+
type DeleteViewError = DeleteViewErrors[keyof DeleteViewErrors];
|
|
9938
|
+
type DeleteViewResponses = {
|
|
8334
9939
|
/**
|
|
8335
9940
|
* Deleted
|
|
8336
9941
|
*/
|
|
8337
9942
|
204: void;
|
|
8338
9943
|
};
|
|
8339
|
-
type
|
|
8340
|
-
type
|
|
9944
|
+
type DeleteViewResponse = DeleteViewResponses[keyof DeleteViewResponses];
|
|
9945
|
+
type GetViewData = {
|
|
8341
9946
|
body?: never;
|
|
8342
9947
|
path: {
|
|
8343
9948
|
/**
|
|
8344
|
-
*
|
|
9949
|
+
* View id (vw_...).
|
|
8345
9950
|
*/
|
|
8346
9951
|
id: string;
|
|
8347
9952
|
};
|
|
8348
|
-
query?:
|
|
8349
|
-
|
|
8350
|
-
* 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.
|
|
8351
|
-
*/
|
|
8352
|
-
groupId?: string;
|
|
8353
|
-
};
|
|
8354
|
-
url: '/v1/segments/{id}';
|
|
9953
|
+
query?: never;
|
|
9954
|
+
url: '/v1/views/{id}';
|
|
8355
9955
|
};
|
|
8356
|
-
type
|
|
9956
|
+
type GetViewErrors = {
|
|
8357
9957
|
/**
|
|
8358
9958
|
* Missing or invalid API key
|
|
8359
9959
|
*/
|
|
8360
9960
|
401: ErrorResponse;
|
|
8361
9961
|
/**
|
|
8362
|
-
* No such
|
|
9962
|
+
* No such view in this workspace
|
|
8363
9963
|
*/
|
|
8364
9964
|
404: ErrorResponse;
|
|
8365
9965
|
};
|
|
8366
|
-
type
|
|
8367
|
-
type
|
|
9966
|
+
type GetViewError = GetViewErrors[keyof GetViewErrors];
|
|
9967
|
+
type GetViewResponses = {
|
|
8368
9968
|
/**
|
|
8369
|
-
*
|
|
9969
|
+
* The view
|
|
8370
9970
|
*/
|
|
8371
|
-
200:
|
|
9971
|
+
200: View;
|
|
8372
9972
|
};
|
|
8373
|
-
type
|
|
8374
|
-
type
|
|
8375
|
-
/**
|
|
8376
|
-
* Omitted fields are untouched.
|
|
8377
|
-
*/
|
|
9973
|
+
type GetViewResponse = GetViewResponses[keyof GetViewResponses];
|
|
9974
|
+
type UpdateViewData = {
|
|
8378
9975
|
body: {
|
|
9976
|
+
/**
|
|
9977
|
+
* View name, unique in the workspace.
|
|
9978
|
+
*/
|
|
8379
9979
|
name?: string;
|
|
9980
|
+
/**
|
|
9981
|
+
* What the view is for.
|
|
9982
|
+
*/
|
|
8380
9983
|
description?: string;
|
|
8381
9984
|
/**
|
|
8382
9985
|
* Replaces the whole filter.
|
|
8383
9986
|
*/
|
|
8384
9987
|
filter?: {
|
|
8385
9988
|
/**
|
|
8386
|
-
*
|
|
9989
|
+
* Substring in the post text or the author's name.
|
|
9990
|
+
*/
|
|
9991
|
+
q?: string;
|
|
9992
|
+
/**
|
|
9993
|
+
* Only matches of any of these keywords.
|
|
9994
|
+
*/
|
|
9995
|
+
keywordIds?: Array<string>;
|
|
9996
|
+
/**
|
|
9997
|
+
* Never matches of these keywords.
|
|
9998
|
+
*/
|
|
9999
|
+
notKeywordIds?: Array<string>;
|
|
10000
|
+
/**
|
|
10001
|
+
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
10002
|
+
*/
|
|
10003
|
+
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
10004
|
+
/**
|
|
10005
|
+
* Never matches of keywords of these kinds.
|
|
10006
|
+
*/
|
|
10007
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
10008
|
+
/**
|
|
10009
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
10010
|
+
*/
|
|
10011
|
+
groupIds?: Array<string>;
|
|
10012
|
+
/**
|
|
10013
|
+
* Never matches of keywords in these groups.
|
|
10014
|
+
*/
|
|
10015
|
+
notGroupIds?: Array<string>;
|
|
10016
|
+
/**
|
|
10017
|
+
* Only posts from any of these platforms.
|
|
10018
|
+
*/
|
|
10019
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10020
|
+
/**
|
|
10021
|
+
* Never posts from these platforms.
|
|
10022
|
+
*/
|
|
10023
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10024
|
+
/**
|
|
10025
|
+
* Only mentions in this status: open, ignored, done.
|
|
10026
|
+
*/
|
|
10027
|
+
status?: 'open' | 'ignored' | 'done';
|
|
10028
|
+
/**
|
|
10029
|
+
* true: only mentions the classifier scored relevant; false: only the rest.
|
|
10030
|
+
*/
|
|
10031
|
+
relevant?: boolean;
|
|
10032
|
+
/**
|
|
10033
|
+
* Only mentions scored at least this.
|
|
10034
|
+
*/
|
|
10035
|
+
minRelevance?: number;
|
|
10036
|
+
/**
|
|
10037
|
+
* Only mentions whose classifier confidence is at least this.
|
|
10038
|
+
*/
|
|
10039
|
+
minConfidence?: number;
|
|
10040
|
+
/**
|
|
10041
|
+
* Only these sentiments.
|
|
10042
|
+
*/
|
|
10043
|
+
sentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
10044
|
+
/**
|
|
10045
|
+
* Never these sentiments; an unscored mention still passes.
|
|
10046
|
+
*/
|
|
10047
|
+
notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
|
|
10048
|
+
/**
|
|
10049
|
+
* Only mentions carrying any of these intent or topic tags.
|
|
10050
|
+
*/
|
|
10051
|
+
intents?: Array<string>;
|
|
10052
|
+
/**
|
|
10053
|
+
* Never mentions carrying these tags.
|
|
10054
|
+
*/
|
|
10055
|
+
notIntents?: Array<string>;
|
|
10056
|
+
/**
|
|
10057
|
+
* true: only posts that read as machine-made; false: only the rest.
|
|
10058
|
+
*/
|
|
10059
|
+
automated?: boolean;
|
|
10060
|
+
/**
|
|
10061
|
+
* Only posts in any of these languages (ISO 639-1).
|
|
10062
|
+
*/
|
|
10063
|
+
languages?: Array<string>;
|
|
10064
|
+
/**
|
|
10065
|
+
* Never posts in these languages; an unknown language still passes.
|
|
10066
|
+
*/
|
|
10067
|
+
notLanguages?: Array<string>;
|
|
10068
|
+
/**
|
|
10069
|
+
* Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
|
|
10070
|
+
*/
|
|
10071
|
+
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'>;
|
|
10072
|
+
/**
|
|
10073
|
+
* Never posts whose author is in these countries; an unknown country still passes.
|
|
10074
|
+
*/
|
|
10075
|
+
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'>;
|
|
10076
|
+
/**
|
|
10077
|
+
* true: only posts by companies, brands and organizations; false: only posts by people.
|
|
8387
10078
|
*/
|
|
8388
|
-
|
|
10079
|
+
organization?: boolean;
|
|
8389
10080
|
/**
|
|
8390
|
-
*
|
|
10081
|
+
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
8391
10082
|
*/
|
|
8392
10083
|
tags?: Array<string>;
|
|
8393
10084
|
/**
|
|
8394
|
-
*
|
|
10085
|
+
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
8395
10086
|
*/
|
|
8396
|
-
|
|
10087
|
+
notTags?: Array<string>;
|
|
8397
10088
|
/**
|
|
8398
|
-
*
|
|
10089
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
8399
10090
|
*/
|
|
8400
|
-
|
|
10091
|
+
labels?: Array<string>;
|
|
8401
10092
|
/**
|
|
8402
|
-
*
|
|
10093
|
+
* Never mentions carrying any of these labels.
|
|
8403
10094
|
*/
|
|
8404
|
-
|
|
10095
|
+
notLabels?: Array<string>;
|
|
8405
10096
|
/**
|
|
8406
|
-
*
|
|
10097
|
+
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
8407
10098
|
*/
|
|
8408
|
-
|
|
10099
|
+
linkHosts?: Array<string>;
|
|
8409
10100
|
/**
|
|
8410
|
-
*
|
|
10101
|
+
* Never posts linking to these hosts.
|
|
8411
10102
|
*/
|
|
8412
|
-
|
|
10103
|
+
notLinkHosts?: Array<string>;
|
|
8413
10104
|
/**
|
|
8414
|
-
*
|
|
10105
|
+
* Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
|
|
8415
10106
|
*/
|
|
8416
|
-
|
|
10107
|
+
subreddits?: Array<string>;
|
|
8417
10108
|
/**
|
|
8418
|
-
* Never
|
|
10109
|
+
* Never Reddit posts from these subreddits; posts from other platforms still pass.
|
|
8419
10110
|
*/
|
|
8420
|
-
|
|
10111
|
+
notSubreddits?: Array<string>;
|
|
8421
10112
|
/**
|
|
8422
|
-
*
|
|
10113
|
+
* Only authors with at least this many followers; unknown reach never passes.
|
|
8423
10114
|
*/
|
|
8424
|
-
|
|
10115
|
+
minFollowers?: number;
|
|
8425
10116
|
/**
|
|
8426
|
-
*
|
|
10117
|
+
* Only authors with at most this many followers; unknown reach never passes.
|
|
8427
10118
|
*/
|
|
8428
|
-
|
|
10119
|
+
maxFollowers?: number;
|
|
8429
10120
|
/**
|
|
8430
|
-
*
|
|
10121
|
+
* true: only replies and comments; false: only top-level posts.
|
|
8431
10122
|
*/
|
|
8432
|
-
|
|
10123
|
+
isReply?: boolean;
|
|
8433
10124
|
/**
|
|
8434
|
-
*
|
|
10125
|
+
* Only posts (post), only comments (comment) or only GitHub repository events (repository).
|
|
8435
10126
|
*/
|
|
8436
|
-
|
|
10127
|
+
kind?: 'post' | 'comment' | 'repository';
|
|
8437
10128
|
/**
|
|
8438
|
-
*
|
|
10129
|
+
* Never these authors: display names, handles or profile URLs.
|
|
8439
10130
|
*/
|
|
8440
|
-
|
|
10131
|
+
notAuthors?: Array<string>;
|
|
8441
10132
|
/**
|
|
8442
|
-
*
|
|
10133
|
+
* Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
|
|
8443
10134
|
*/
|
|
8444
|
-
|
|
10135
|
+
excludeAuthors?: Array<string>;
|
|
8445
10136
|
/**
|
|
8446
|
-
*
|
|
10137
|
+
* Only app store reviews with any of these star ratings; every other post fails it.
|
|
8447
10138
|
*/
|
|
8448
|
-
|
|
10139
|
+
ratings?: Array<number>;
|
|
8449
10140
|
/**
|
|
8450
|
-
*
|
|
10141
|
+
* Never reviews with these star ratings; posts that are not reviews still pass.
|
|
8451
10142
|
*/
|
|
8452
|
-
|
|
10143
|
+
notRatings?: Array<number>;
|
|
8453
10144
|
/**
|
|
8454
|
-
*
|
|
10145
|
+
* 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.
|
|
8455
10146
|
*/
|
|
8456
|
-
|
|
10147
|
+
minLikes?: number;
|
|
10148
|
+
/**
|
|
10149
|
+
* 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.
|
|
10150
|
+
*/
|
|
10151
|
+
minReposts?: number;
|
|
10152
|
+
/**
|
|
10153
|
+
* 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.
|
|
10154
|
+
*/
|
|
10155
|
+
minReplies?: number;
|
|
10156
|
+
/**
|
|
10157
|
+
* 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.
|
|
10158
|
+
*/
|
|
10159
|
+
minQuotes?: number;
|
|
10160
|
+
/**
|
|
10161
|
+
* 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.
|
|
10162
|
+
*/
|
|
10163
|
+
minViews?: number;
|
|
10164
|
+
/**
|
|
10165
|
+
* 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.
|
|
10166
|
+
*/
|
|
10167
|
+
minBookmarks?: number;
|
|
10168
|
+
/**
|
|
10169
|
+
* OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
|
|
10170
|
+
*/
|
|
10171
|
+
anyOf?: Array<FilterGroup>;
|
|
8457
10172
|
};
|
|
8458
10173
|
};
|
|
8459
10174
|
path: {
|
|
8460
10175
|
/**
|
|
8461
|
-
*
|
|
10176
|
+
* View id (vw_...).
|
|
8462
10177
|
*/
|
|
8463
10178
|
id: string;
|
|
8464
10179
|
};
|
|
8465
|
-
query?:
|
|
8466
|
-
|
|
8467
|
-
* 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.
|
|
8468
|
-
*/
|
|
8469
|
-
groupId?: string;
|
|
8470
|
-
};
|
|
8471
|
-
url: '/v1/segments/{id}';
|
|
10180
|
+
query?: never;
|
|
10181
|
+
url: '/v1/views/{id}';
|
|
8472
10182
|
};
|
|
8473
|
-
type
|
|
10183
|
+
type UpdateViewErrors = {
|
|
10184
|
+
/**
|
|
10185
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
10186
|
+
*/
|
|
10187
|
+
400: ErrorResponse;
|
|
8474
10188
|
/**
|
|
8475
10189
|
* Missing or invalid API key
|
|
8476
10190
|
*/
|
|
8477
10191
|
401: ErrorResponse;
|
|
8478
10192
|
/**
|
|
8479
|
-
* No such
|
|
10193
|
+
* No such view in this workspace
|
|
8480
10194
|
*/
|
|
8481
10195
|
404: ErrorResponse;
|
|
8482
10196
|
/**
|
|
8483
|
-
* A
|
|
10197
|
+
* A view with that name already exists (duplicate_view)
|
|
8484
10198
|
*/
|
|
8485
10199
|
409: ErrorResponse;
|
|
8486
10200
|
};
|
|
8487
|
-
type
|
|
8488
|
-
type
|
|
10201
|
+
type UpdateViewError = UpdateViewErrors[keyof UpdateViewErrors];
|
|
10202
|
+
type UpdateViewResponses = {
|
|
8489
10203
|
/**
|
|
8490
|
-
* The updated
|
|
10204
|
+
* The updated view
|
|
8491
10205
|
*/
|
|
8492
|
-
200:
|
|
10206
|
+
200: View;
|
|
8493
10207
|
};
|
|
8494
|
-
type
|
|
8495
|
-
type
|
|
10208
|
+
type UpdateViewResponse = UpdateViewResponses[keyof UpdateViewResponses];
|
|
10209
|
+
type ListAutomationsData = {
|
|
8496
10210
|
body?: never;
|
|
8497
10211
|
path?: never;
|
|
8498
10212
|
query?: never;
|
|
8499
|
-
url: '/v1/
|
|
10213
|
+
url: '/v1/automations';
|
|
8500
10214
|
};
|
|
8501
|
-
type
|
|
10215
|
+
type ListAutomationsErrors = {
|
|
8502
10216
|
/**
|
|
8503
10217
|
* Missing or invalid API key
|
|
8504
10218
|
*/
|
|
8505
10219
|
401: ErrorResponse;
|
|
8506
10220
|
};
|
|
8507
|
-
type
|
|
8508
|
-
type
|
|
10221
|
+
type ListAutomationsError = ListAutomationsErrors[keyof ListAutomationsErrors];
|
|
10222
|
+
type ListAutomationsResponses = {
|
|
8509
10223
|
/**
|
|
8510
|
-
*
|
|
10224
|
+
* Automations
|
|
8511
10225
|
*/
|
|
8512
10226
|
200: {
|
|
8513
10227
|
/**
|
|
8514
|
-
*
|
|
10228
|
+
* Automations in the order they run, oldest first.
|
|
8515
10229
|
*/
|
|
8516
10230
|
data: Array<{
|
|
8517
10231
|
/**
|
|
8518
|
-
*
|
|
10232
|
+
* Automation id (atm_...).
|
|
8519
10233
|
*/
|
|
8520
10234
|
id: string;
|
|
10235
|
+
/**
|
|
10236
|
+
* Automation name, unique in the workspace.
|
|
10237
|
+
*/
|
|
8521
10238
|
name: string;
|
|
8522
|
-
|
|
10239
|
+
/**
|
|
10240
|
+
* false: kept but not run.
|
|
10241
|
+
*/
|
|
10242
|
+
enabled: boolean;
|
|
10243
|
+
/**
|
|
10244
|
+
* Which mentions it acts on: the fields of GET /v1/mentions, like a view.
|
|
10245
|
+
*/
|
|
8523
10246
|
filter: {
|
|
8524
10247
|
/**
|
|
8525
10248
|
* Substring in the post text or the author's name.
|
|
@@ -8537,6 +10260,10 @@ type ListViewsResponses = {
|
|
|
8537
10260
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
8538
10261
|
*/
|
|
8539
10262
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
10263
|
+
/**
|
|
10264
|
+
* Never matches of keywords of these kinds.
|
|
10265
|
+
*/
|
|
10266
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
8540
10267
|
/**
|
|
8541
10268
|
* Only matches of keywords in any of these groups (grp_...).
|
|
8542
10269
|
*/
|
|
@@ -8617,6 +10344,14 @@ type ListViewsResponses = {
|
|
|
8617
10344
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
8618
10345
|
*/
|
|
8619
10346
|
notTags?: Array<string>;
|
|
10347
|
+
/**
|
|
10348
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
10349
|
+
*/
|
|
10350
|
+
labels?: Array<string>;
|
|
10351
|
+
/**
|
|
10352
|
+
* Never mentions carrying any of these labels.
|
|
10353
|
+
*/
|
|
10354
|
+
notLabels?: Array<string>;
|
|
8620
10355
|
/**
|
|
8621
10356
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
8622
10357
|
*/
|
|
@@ -8694,6 +10429,19 @@ type ListViewsResponses = {
|
|
|
8694
10429
|
*/
|
|
8695
10430
|
anyOf?: Array<FilterGroup>;
|
|
8696
10431
|
};
|
|
10432
|
+
/**
|
|
10433
|
+
* What it does to each mention the filter selects.
|
|
10434
|
+
*/
|
|
10435
|
+
actions: {
|
|
10436
|
+
/**
|
|
10437
|
+
* Labels it adds.
|
|
10438
|
+
*/
|
|
10439
|
+
addLabels: Array<string>;
|
|
10440
|
+
/**
|
|
10441
|
+
* The member it assigns, or null.
|
|
10442
|
+
*/
|
|
10443
|
+
assigneeId: string | null;
|
|
10444
|
+
};
|
|
8697
10445
|
/**
|
|
8698
10446
|
* ISO 8601 timestamp, UTC.
|
|
8699
10447
|
*/
|
|
@@ -8705,19 +10453,19 @@ type ListViewsResponses = {
|
|
|
8705
10453
|
}>;
|
|
8706
10454
|
};
|
|
8707
10455
|
};
|
|
8708
|
-
type
|
|
8709
|
-
type
|
|
10456
|
+
type ListAutomationsResponse = ListAutomationsResponses[keyof ListAutomationsResponses];
|
|
10457
|
+
type CreateAutomationData = {
|
|
8710
10458
|
body: {
|
|
8711
10459
|
/**
|
|
8712
10460
|
* Unique per workspace, case-insensitive.
|
|
8713
10461
|
*/
|
|
8714
10462
|
name: string;
|
|
8715
10463
|
/**
|
|
8716
|
-
*
|
|
10464
|
+
* false saves it without running it.
|
|
8717
10465
|
*/
|
|
8718
|
-
|
|
10466
|
+
enabled?: boolean;
|
|
8719
10467
|
/**
|
|
8720
|
-
*
|
|
10468
|
+
* Which new mentions it acts on; empty acts on every one.
|
|
8721
10469
|
*/
|
|
8722
10470
|
filter?: {
|
|
8723
10471
|
/**
|
|
@@ -8736,6 +10484,10 @@ type CreateViewData = {
|
|
|
8736
10484
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
8737
10485
|
*/
|
|
8738
10486
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
10487
|
+
/**
|
|
10488
|
+
* Never matches of keywords of these kinds.
|
|
10489
|
+
*/
|
|
10490
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
8739
10491
|
/**
|
|
8740
10492
|
* Only matches of keywords in any of these groups (grp_...).
|
|
8741
10493
|
*/
|
|
@@ -8816,6 +10568,14 @@ type CreateViewData = {
|
|
|
8816
10568
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
8817
10569
|
*/
|
|
8818
10570
|
notTags?: Array<string>;
|
|
10571
|
+
/**
|
|
10572
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
10573
|
+
*/
|
|
10574
|
+
labels?: Array<string>;
|
|
10575
|
+
/**
|
|
10576
|
+
* Never mentions carrying any of these labels.
|
|
10577
|
+
*/
|
|
10578
|
+
notLabels?: Array<string>;
|
|
8819
10579
|
/**
|
|
8820
10580
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
8821
10581
|
*/
|
|
@@ -8893,6 +10653,19 @@ type CreateViewData = {
|
|
|
8893
10653
|
*/
|
|
8894
10654
|
anyOf?: Array<FilterGroup>;
|
|
8895
10655
|
};
|
|
10656
|
+
/**
|
|
10657
|
+
* What to do to each mention the filter selects; at least one action.
|
|
10658
|
+
*/
|
|
10659
|
+
actions: {
|
|
10660
|
+
/**
|
|
10661
|
+
* Labels to add, at most 10. A mention keeps at most 20 labels.
|
|
10662
|
+
*/
|
|
10663
|
+
addLabels?: Array<string>;
|
|
10664
|
+
/**
|
|
10665
|
+
* A workspace member (user id) to assign when the mention has nobody yet; someone already assigned is kept.
|
|
10666
|
+
*/
|
|
10667
|
+
assigneeId?: string | null;
|
|
10668
|
+
};
|
|
8896
10669
|
};
|
|
8897
10670
|
headers?: {
|
|
8898
10671
|
/**
|
|
@@ -8902,11 +10675,11 @@ type CreateViewData = {
|
|
|
8902
10675
|
};
|
|
8903
10676
|
path?: never;
|
|
8904
10677
|
query?: never;
|
|
8905
|
-
url: '/v1/
|
|
10678
|
+
url: '/v1/automations';
|
|
8906
10679
|
};
|
|
8907
|
-
type
|
|
10680
|
+
type CreateAutomationErrors = {
|
|
8908
10681
|
/**
|
|
8909
|
-
* Invalid
|
|
10682
|
+
* Invalid request (no action, a filter_too_complex filter), or invalid_assignee: the assignee is not a workspace member
|
|
8910
10683
|
*/
|
|
8911
10684
|
400: ErrorResponse;
|
|
8912
10685
|
/**
|
|
@@ -8914,80 +10687,86 @@ type CreateViewErrors = {
|
|
|
8914
10687
|
*/
|
|
8915
10688
|
401: ErrorResponse;
|
|
8916
10689
|
/**
|
|
8917
|
-
*
|
|
10690
|
+
* duplicate_automation: the name is taken; automation_limit_reached: the workspace holds 25
|
|
8918
10691
|
*/
|
|
8919
10692
|
409: ErrorResponse;
|
|
8920
10693
|
};
|
|
8921
|
-
type
|
|
8922
|
-
type
|
|
10694
|
+
type CreateAutomationError = CreateAutomationErrors[keyof CreateAutomationErrors];
|
|
10695
|
+
type CreateAutomationResponses = {
|
|
8923
10696
|
/**
|
|
8924
|
-
* The
|
|
10697
|
+
* The automation
|
|
8925
10698
|
*/
|
|
8926
|
-
201:
|
|
10699
|
+
201: Automation;
|
|
8927
10700
|
};
|
|
8928
|
-
type
|
|
8929
|
-
type
|
|
10701
|
+
type CreateAutomationResponse = CreateAutomationResponses[keyof CreateAutomationResponses];
|
|
10702
|
+
type DeleteAutomationData = {
|
|
8930
10703
|
body?: never;
|
|
8931
10704
|
path: {
|
|
8932
10705
|
/**
|
|
8933
|
-
*
|
|
10706
|
+
* Automation id (atm_...).
|
|
8934
10707
|
*/
|
|
8935
10708
|
id: string;
|
|
8936
10709
|
};
|
|
8937
10710
|
query?: never;
|
|
8938
|
-
url: '/v1/
|
|
10711
|
+
url: '/v1/automations/{id}';
|
|
8939
10712
|
};
|
|
8940
|
-
type
|
|
10713
|
+
type DeleteAutomationErrors = {
|
|
8941
10714
|
/**
|
|
8942
10715
|
* Missing or invalid API key
|
|
8943
10716
|
*/
|
|
8944
10717
|
401: ErrorResponse;
|
|
8945
10718
|
/**
|
|
8946
|
-
* No such
|
|
10719
|
+
* No such automation in this workspace
|
|
8947
10720
|
*/
|
|
8948
10721
|
404: ErrorResponse;
|
|
8949
10722
|
};
|
|
8950
|
-
type
|
|
8951
|
-
type
|
|
10723
|
+
type DeleteAutomationError = DeleteAutomationErrors[keyof DeleteAutomationErrors];
|
|
10724
|
+
type DeleteAutomationResponses = {
|
|
8952
10725
|
/**
|
|
8953
10726
|
* Deleted
|
|
8954
10727
|
*/
|
|
8955
10728
|
204: void;
|
|
8956
10729
|
};
|
|
8957
|
-
type
|
|
8958
|
-
type
|
|
10730
|
+
type DeleteAutomationResponse = DeleteAutomationResponses[keyof DeleteAutomationResponses];
|
|
10731
|
+
type GetAutomationData = {
|
|
8959
10732
|
body?: never;
|
|
8960
10733
|
path: {
|
|
8961
10734
|
/**
|
|
8962
|
-
*
|
|
10735
|
+
* Automation id (atm_...).
|
|
8963
10736
|
*/
|
|
8964
10737
|
id: string;
|
|
8965
10738
|
};
|
|
8966
10739
|
query?: never;
|
|
8967
|
-
url: '/v1/
|
|
10740
|
+
url: '/v1/automations/{id}';
|
|
8968
10741
|
};
|
|
8969
|
-
type
|
|
10742
|
+
type GetAutomationErrors = {
|
|
8970
10743
|
/**
|
|
8971
10744
|
* Missing or invalid API key
|
|
8972
10745
|
*/
|
|
8973
10746
|
401: ErrorResponse;
|
|
8974
10747
|
/**
|
|
8975
|
-
* No such
|
|
10748
|
+
* No such automation in this workspace
|
|
8976
10749
|
*/
|
|
8977
10750
|
404: ErrorResponse;
|
|
8978
10751
|
};
|
|
8979
|
-
type
|
|
8980
|
-
type
|
|
10752
|
+
type GetAutomationError = GetAutomationErrors[keyof GetAutomationErrors];
|
|
10753
|
+
type GetAutomationResponses = {
|
|
8981
10754
|
/**
|
|
8982
|
-
* The
|
|
10755
|
+
* The automation
|
|
8983
10756
|
*/
|
|
8984
|
-
200:
|
|
10757
|
+
200: Automation;
|
|
8985
10758
|
};
|
|
8986
|
-
type
|
|
8987
|
-
type
|
|
10759
|
+
type GetAutomationResponse = GetAutomationResponses[keyof GetAutomationResponses];
|
|
10760
|
+
type UpdateAutomationData = {
|
|
8988
10761
|
body: {
|
|
10762
|
+
/**
|
|
10763
|
+
* Automation name, unique in the workspace.
|
|
10764
|
+
*/
|
|
8989
10765
|
name?: string;
|
|
8990
|
-
|
|
10766
|
+
/**
|
|
10767
|
+
* false stops it; true runs it again on new mentions.
|
|
10768
|
+
*/
|
|
10769
|
+
enabled?: boolean;
|
|
8991
10770
|
/**
|
|
8992
10771
|
* Replaces the whole filter.
|
|
8993
10772
|
*/
|
|
@@ -9008,6 +10787,10 @@ type UpdateViewData = {
|
|
|
9008
10787
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
9009
10788
|
*/
|
|
9010
10789
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
10790
|
+
/**
|
|
10791
|
+
* Never matches of keywords of these kinds.
|
|
10792
|
+
*/
|
|
10793
|
+
notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
9011
10794
|
/**
|
|
9012
10795
|
* Only matches of keywords in any of these groups (grp_...).
|
|
9013
10796
|
*/
|
|
@@ -9088,6 +10871,14 @@ type UpdateViewData = {
|
|
|
9088
10871
|
* Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
9089
10872
|
*/
|
|
9090
10873
|
notTags?: Array<string>;
|
|
10874
|
+
/**
|
|
10875
|
+
* Only mentions carrying any of these labels (exact, case-sensitive).
|
|
10876
|
+
*/
|
|
10877
|
+
labels?: Array<string>;
|
|
10878
|
+
/**
|
|
10879
|
+
* Never mentions carrying any of these labels.
|
|
10880
|
+
*/
|
|
10881
|
+
notLabels?: Array<string>;
|
|
9091
10882
|
/**
|
|
9092
10883
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it.
|
|
9093
10884
|
*/
|
|
@@ -9165,38 +10956,106 @@ type UpdateViewData = {
|
|
|
9165
10956
|
*/
|
|
9166
10957
|
anyOf?: Array<FilterGroup>;
|
|
9167
10958
|
};
|
|
10959
|
+
/**
|
|
10960
|
+
* Replaces every action.
|
|
10961
|
+
*/
|
|
10962
|
+
actions?: {
|
|
10963
|
+
/**
|
|
10964
|
+
* Labels to add, at most 10. A mention keeps at most 20 labels.
|
|
10965
|
+
*/
|
|
10966
|
+
addLabels?: Array<string>;
|
|
10967
|
+
/**
|
|
10968
|
+
* A workspace member (user id) to assign when the mention has nobody yet; someone already assigned is kept.
|
|
10969
|
+
*/
|
|
10970
|
+
assigneeId?: string | null;
|
|
10971
|
+
};
|
|
9168
10972
|
};
|
|
9169
10973
|
path: {
|
|
9170
10974
|
/**
|
|
9171
|
-
*
|
|
10975
|
+
* Automation id (atm_...).
|
|
9172
10976
|
*/
|
|
9173
10977
|
id: string;
|
|
9174
10978
|
};
|
|
9175
10979
|
query?: never;
|
|
9176
|
-
url: '/v1/
|
|
10980
|
+
url: '/v1/automations/{id}';
|
|
9177
10981
|
};
|
|
9178
|
-
type
|
|
10982
|
+
type UpdateAutomationErrors = {
|
|
10983
|
+
/**
|
|
10984
|
+
* Invalid request, or invalid_assignee: the assignee is not a workspace member
|
|
10985
|
+
*/
|
|
10986
|
+
400: ErrorResponse;
|
|
9179
10987
|
/**
|
|
9180
10988
|
* Missing or invalid API key
|
|
9181
10989
|
*/
|
|
9182
10990
|
401: ErrorResponse;
|
|
9183
10991
|
/**
|
|
9184
|
-
* No such
|
|
10992
|
+
* No such automation in this workspace
|
|
9185
10993
|
*/
|
|
9186
10994
|
404: ErrorResponse;
|
|
9187
10995
|
/**
|
|
9188
|
-
*
|
|
10996
|
+
* duplicate_automation: the name is taken
|
|
9189
10997
|
*/
|
|
9190
10998
|
409: ErrorResponse;
|
|
9191
10999
|
};
|
|
9192
|
-
type
|
|
9193
|
-
type
|
|
11000
|
+
type UpdateAutomationError = UpdateAutomationErrors[keyof UpdateAutomationErrors];
|
|
11001
|
+
type UpdateAutomationResponses = {
|
|
9194
11002
|
/**
|
|
9195
|
-
* The updated
|
|
11003
|
+
* The updated automation
|
|
9196
11004
|
*/
|
|
9197
|
-
200:
|
|
11005
|
+
200: Automation;
|
|
11006
|
+
};
|
|
11007
|
+
type UpdateAutomationResponse = UpdateAutomationResponses[keyof UpdateAutomationResponses];
|
|
11008
|
+
type ListLabelsData = {
|
|
11009
|
+
body?: never;
|
|
11010
|
+
path?: never;
|
|
11011
|
+
query?: {
|
|
11012
|
+
/**
|
|
11013
|
+
* Page size, 1 to 100.
|
|
11014
|
+
*/
|
|
11015
|
+
limit?: number;
|
|
11016
|
+
/**
|
|
11017
|
+
* Skip this many labels.
|
|
11018
|
+
*/
|
|
11019
|
+
offset?: number | null;
|
|
11020
|
+
};
|
|
11021
|
+
url: '/v1/labels';
|
|
11022
|
+
};
|
|
11023
|
+
type ListLabelsErrors = {
|
|
11024
|
+
/**
|
|
11025
|
+
* Invalid limit or offset (validation_error)
|
|
11026
|
+
*/
|
|
11027
|
+
400: ErrorResponse;
|
|
11028
|
+
/**
|
|
11029
|
+
* Missing or invalid API key
|
|
11030
|
+
*/
|
|
11031
|
+
401: ErrorResponse;
|
|
11032
|
+
};
|
|
11033
|
+
type ListLabelsError = ListLabelsErrors[keyof ListLabelsErrors];
|
|
11034
|
+
type ListLabelsResponses = {
|
|
11035
|
+
/**
|
|
11036
|
+
* Labels
|
|
11037
|
+
*/
|
|
11038
|
+
200: {
|
|
11039
|
+
/**
|
|
11040
|
+
* Labels in the workspace, the most used first.
|
|
11041
|
+
*/
|
|
11042
|
+
data: Array<{
|
|
11043
|
+
/**
|
|
11044
|
+
* The label, exactly as written.
|
|
11045
|
+
*/
|
|
11046
|
+
name: string;
|
|
11047
|
+
/**
|
|
11048
|
+
* Mentions carrying it, hidden ones included (muted authors, cross-post copies).
|
|
11049
|
+
*/
|
|
11050
|
+
mentions: number;
|
|
11051
|
+
}>;
|
|
11052
|
+
/**
|
|
11053
|
+
* Distinct labels in the workspace.
|
|
11054
|
+
*/
|
|
11055
|
+
total: number;
|
|
11056
|
+
};
|
|
9198
11057
|
};
|
|
9199
|
-
type
|
|
11058
|
+
type ListLabelsResponse = ListLabelsResponses[keyof ListLabelsResponses];
|
|
9200
11059
|
type ListAttentionData = {
|
|
9201
11060
|
body?: never;
|
|
9202
11061
|
path?: never;
|
|
@@ -9236,6 +11095,9 @@ type ListAttentionResponses = {
|
|
|
9236
11095
|
* Attention items
|
|
9237
11096
|
*/
|
|
9238
11097
|
200: {
|
|
11098
|
+
/**
|
|
11099
|
+
* The attention items.
|
|
11100
|
+
*/
|
|
9239
11101
|
data: Array<AttentionItem>;
|
|
9240
11102
|
/**
|
|
9241
11103
|
* Pass as cursor for the next page; null on the last one.
|
|
@@ -9246,6 +11108,12 @@ type ListAttentionResponses = {
|
|
|
9246
11108
|
type ListAttentionResponse = ListAttentionResponses[keyof ListAttentionResponses];
|
|
9247
11109
|
type DismissAttentionData = {
|
|
9248
11110
|
body?: never;
|
|
11111
|
+
headers?: {
|
|
11112
|
+
/**
|
|
11113
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
11114
|
+
*/
|
|
11115
|
+
'idempotency-key'?: string;
|
|
11116
|
+
};
|
|
9249
11117
|
path: {
|
|
9250
11118
|
/**
|
|
9251
11119
|
* Attention item id (att_...).
|
|
@@ -9285,6 +11153,10 @@ type ListGroupsData = {
|
|
|
9285
11153
|
url: '/v1/groups';
|
|
9286
11154
|
};
|
|
9287
11155
|
type ListGroupsErrors = {
|
|
11156
|
+
/**
|
|
11157
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
11158
|
+
*/
|
|
11159
|
+
400: ErrorResponse;
|
|
9288
11160
|
/**
|
|
9289
11161
|
* Missing or invalid API key
|
|
9290
11162
|
*/
|
|
@@ -9355,6 +11227,10 @@ type CreateGroupData = {
|
|
|
9355
11227
|
url: '/v1/groups';
|
|
9356
11228
|
};
|
|
9357
11229
|
type CreateGroupErrors = {
|
|
11230
|
+
/**
|
|
11231
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
11232
|
+
*/
|
|
11233
|
+
400: ErrorResponse;
|
|
9358
11234
|
/**
|
|
9359
11235
|
* Missing or invalid API key
|
|
9360
11236
|
*/
|
|
@@ -9516,7 +11392,13 @@ type UpdateCompanyData = {
|
|
|
9516
11392
|
* Omitted fields are untouched.
|
|
9517
11393
|
*/
|
|
9518
11394
|
body: {
|
|
11395
|
+
/**
|
|
11396
|
+
* Company name.
|
|
11397
|
+
*/
|
|
9519
11398
|
name?: string;
|
|
11399
|
+
/**
|
|
11400
|
+
* What the company does; the classifier reads it.
|
|
11401
|
+
*/
|
|
9520
11402
|
description?: string;
|
|
9521
11403
|
/**
|
|
9522
11404
|
* Replaces the whole list.
|
|
@@ -9548,6 +11430,10 @@ type UpdateCompanyData = {
|
|
|
9548
11430
|
url: '/v1/company';
|
|
9549
11431
|
};
|
|
9550
11432
|
type UpdateCompanyErrors = {
|
|
11433
|
+
/**
|
|
11434
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
11435
|
+
*/
|
|
11436
|
+
400: ErrorResponse;
|
|
9551
11437
|
/**
|
|
9552
11438
|
* Missing or invalid API key
|
|
9553
11439
|
*/
|
|
@@ -9583,11 +11469,17 @@ type ListApiKeysResponses = {
|
|
|
9583
11469
|
* Every key, newest first, without the secret part
|
|
9584
11470
|
*/
|
|
9585
11471
|
200: {
|
|
11472
|
+
/**
|
|
11473
|
+
* Every API key of the workspace; the secret is never shown again.
|
|
11474
|
+
*/
|
|
9586
11475
|
data: Array<{
|
|
9587
11476
|
/**
|
|
9588
11477
|
* Key id (key_...).
|
|
9589
11478
|
*/
|
|
9590
11479
|
id: string;
|
|
11480
|
+
/**
|
|
11481
|
+
* Your name for the key.
|
|
11482
|
+
*/
|
|
9591
11483
|
name: string;
|
|
9592
11484
|
/**
|
|
9593
11485
|
* The first characters of the key, to tell keys apart.
|
|
@@ -9658,6 +11550,9 @@ type CreateApiKeyResponses = {
|
|
|
9658
11550
|
* Key id (key_...).
|
|
9659
11551
|
*/
|
|
9660
11552
|
id: string;
|
|
11553
|
+
/**
|
|
11554
|
+
* Your name for the key.
|
|
11555
|
+
*/
|
|
9661
11556
|
name: string;
|
|
9662
11557
|
/**
|
|
9663
11558
|
* The first characters of the key, to tell keys apart.
|
|
@@ -9753,6 +11648,9 @@ type ListMembersResponses = {
|
|
|
9753
11648
|
* The members
|
|
9754
11649
|
*/
|
|
9755
11650
|
200: {
|
|
11651
|
+
/**
|
|
11652
|
+
* The members.
|
|
11653
|
+
*/
|
|
9756
11654
|
data: Array<Member>;
|
|
9757
11655
|
};
|
|
9758
11656
|
};
|
|
@@ -9775,6 +11673,9 @@ type ListInvitationsResponses = {
|
|
|
9775
11673
|
* The open invitations
|
|
9776
11674
|
*/
|
|
9777
11675
|
200: {
|
|
11676
|
+
/**
|
|
11677
|
+
* The open invitations.
|
|
11678
|
+
*/
|
|
9778
11679
|
data: Array<Invitation>;
|
|
9779
11680
|
};
|
|
9780
11681
|
};
|
|
@@ -9801,6 +11702,10 @@ type CreateInvitationData = {
|
|
|
9801
11702
|
url: '/v1/members/invitations';
|
|
9802
11703
|
};
|
|
9803
11704
|
type CreateInvitationErrors = {
|
|
11705
|
+
/**
|
|
11706
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
11707
|
+
*/
|
|
11708
|
+
400: ErrorResponse;
|
|
9804
11709
|
/**
|
|
9805
11710
|
* Missing or invalid API key
|
|
9806
11711
|
*/
|
|
@@ -9952,6 +11857,18 @@ type GetUsageBreakdownData = {
|
|
|
9952
11857
|
* Only these platforms. A keyword-day belongs to no platform, so with this filter the keyword line reads 0 and only mentions and comments count. Repeatable, or comma-separated.
|
|
9953
11858
|
*/
|
|
9954
11859
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
11860
|
+
/**
|
|
11861
|
+
* Never these keywords (kw_...). Repeatable, or comma-separated.
|
|
11862
|
+
*/
|
|
11863
|
+
notKeywordIds?: Array<string> | null;
|
|
11864
|
+
/**
|
|
11865
|
+
* Never keywords of these groups (grp_...). Repeatable, or comma-separated.
|
|
11866
|
+
*/
|
|
11867
|
+
notGroupIds?: Array<string> | null;
|
|
11868
|
+
/**
|
|
11869
|
+
* Never mentions or comments from these platforms; keyword-days, which belong to no platform, still count. Repeatable, or comma-separated.
|
|
11870
|
+
*/
|
|
11871
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
9955
11872
|
/**
|
|
9956
11873
|
* Rows per page, 1 to 500 (default 100). Only by=keyword can outgrow a page; a window has at most 90 days and a dozen platforms.
|
|
9957
11874
|
*/
|
|
@@ -10215,7 +12132,13 @@ type UpdateAlertData = {
|
|
|
10215
12132
|
* Omitted fields are untouched.
|
|
10216
12133
|
*/
|
|
10217
12134
|
body: {
|
|
12135
|
+
/**
|
|
12136
|
+
* Rule name.
|
|
12137
|
+
*/
|
|
10218
12138
|
name?: string;
|
|
12139
|
+
/**
|
|
12140
|
+
* false: the rule sends nothing.
|
|
12141
|
+
*/
|
|
10219
12142
|
enabled?: boolean;
|
|
10220
12143
|
mode?: 'instant' | 'hourly' | 'daily' | 'weekly';
|
|
10221
12144
|
/**
|
|
@@ -10262,6 +12185,14 @@ type UpdateAlertData = {
|
|
|
10262
12185
|
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
10263
12186
|
*/
|
|
10264
12187
|
tags?: Array<string>;
|
|
12188
|
+
/**
|
|
12189
|
+
* Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
|
|
12190
|
+
*/
|
|
12191
|
+
labels?: Array<string>;
|
|
12192
|
+
/**
|
|
12193
|
+
* Never mentions carrying any of these labels.
|
|
12194
|
+
*/
|
|
12195
|
+
notLabels?: Array<string>;
|
|
10265
12196
|
/**
|
|
10266
12197
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
10267
12198
|
*/
|
|
@@ -10327,9 +12258,21 @@ type UpdateAlertData = {
|
|
|
10327
12258
|
* Daily and weekly alerts. Ignored on an hourly one, except a weekday, which is refused.
|
|
10328
12259
|
*/
|
|
10329
12260
|
schedule?: {
|
|
12261
|
+
/**
|
|
12262
|
+
* Hour of the day to send, 0 to 23, in timezone.
|
|
12263
|
+
*/
|
|
10330
12264
|
hour: number;
|
|
12265
|
+
/**
|
|
12266
|
+
* Minute past the hour, 0 to 59.
|
|
12267
|
+
*/
|
|
10331
12268
|
minute?: number;
|
|
12269
|
+
/**
|
|
12270
|
+
* IANA zone the schedule runs in (Europe/Madrid).
|
|
12271
|
+
*/
|
|
10332
12272
|
timezone: string;
|
|
12273
|
+
/**
|
|
12274
|
+
* true: send nothing when the window had no mention.
|
|
12275
|
+
*/
|
|
10333
12276
|
skipEmpty?: boolean;
|
|
10334
12277
|
/**
|
|
10335
12278
|
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
@@ -10391,12 +12334,21 @@ type ListAlertsResponses = {
|
|
|
10391
12334
|
* Every alert rule of the org, newest first
|
|
10392
12335
|
*/
|
|
10393
12336
|
200: {
|
|
12337
|
+
/**
|
|
12338
|
+
* Every alert rule of the workspace.
|
|
12339
|
+
*/
|
|
10394
12340
|
data: Array<{
|
|
10395
12341
|
/**
|
|
10396
12342
|
* Alert id (feed_...).
|
|
10397
12343
|
*/
|
|
10398
12344
|
id: string;
|
|
12345
|
+
/**
|
|
12346
|
+
* Rule name.
|
|
12347
|
+
*/
|
|
10399
12348
|
name: string;
|
|
12349
|
+
/**
|
|
12350
|
+
* false: the rule sends nothing.
|
|
12351
|
+
*/
|
|
10400
12352
|
enabled: boolean;
|
|
10401
12353
|
/**
|
|
10402
12354
|
* When it sends; see [Alerts](/alerts).
|
|
@@ -10407,6 +12359,9 @@ type ListAlertsResponses = {
|
|
|
10407
12359
|
* - weekly: one digest a week, on schedule.weekday.
|
|
10408
12360
|
*/
|
|
10409
12361
|
mode: 'instant' | 'hourly' | 'daily' | 'weekly';
|
|
12362
|
+
/**
|
|
12363
|
+
* Which mentions the rule sends.
|
|
12364
|
+
*/
|
|
10410
12365
|
filter: {
|
|
10411
12366
|
/**
|
|
10412
12367
|
* Only these keywords.
|
|
@@ -10448,6 +12403,14 @@ type ListAlertsResponses = {
|
|
|
10448
12403
|
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
10449
12404
|
*/
|
|
10450
12405
|
tags?: Array<string>;
|
|
12406
|
+
/**
|
|
12407
|
+
* Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
|
|
12408
|
+
*/
|
|
12409
|
+
labels?: Array<string>;
|
|
12410
|
+
/**
|
|
12411
|
+
* Never mentions carrying any of these labels.
|
|
12412
|
+
*/
|
|
12413
|
+
notLabels?: Array<string>;
|
|
10451
12414
|
/**
|
|
10452
12415
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
10453
12416
|
*/
|
|
@@ -10513,9 +12476,21 @@ type ListAlertsResponses = {
|
|
|
10513
12476
|
* Daily and weekly alerts only; null for instant and hourly ones.
|
|
10514
12477
|
*/
|
|
10515
12478
|
schedule: {
|
|
12479
|
+
/**
|
|
12480
|
+
* Hour of the day to send, 0 to 23, in timezone.
|
|
12481
|
+
*/
|
|
10516
12482
|
hour: number;
|
|
12483
|
+
/**
|
|
12484
|
+
* Minute past the hour, 0 to 59.
|
|
12485
|
+
*/
|
|
10517
12486
|
minute?: number;
|
|
12487
|
+
/**
|
|
12488
|
+
* IANA zone the schedule runs in (Europe/Madrid).
|
|
12489
|
+
*/
|
|
10518
12490
|
timezone: string;
|
|
12491
|
+
/**
|
|
12492
|
+
* true: send nothing when the window had no mention.
|
|
12493
|
+
*/
|
|
10519
12494
|
skipEmpty?: boolean;
|
|
10520
12495
|
/**
|
|
10521
12496
|
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
@@ -10530,8 +12505,17 @@ type ListAlertsResponses = {
|
|
|
10530
12505
|
* Where it sends.
|
|
10531
12506
|
*/
|
|
10532
12507
|
channels: Array<{
|
|
12508
|
+
/**
|
|
12509
|
+
* Channel id (dest_...).
|
|
12510
|
+
*/
|
|
10533
12511
|
id: string;
|
|
12512
|
+
/**
|
|
12513
|
+
* Channel kind.
|
|
12514
|
+
*/
|
|
10534
12515
|
kind: 'slack' | 'email' | 'webhook' | 'telegram';
|
|
12516
|
+
/**
|
|
12517
|
+
* Channel name.
|
|
12518
|
+
*/
|
|
10535
12519
|
label: string;
|
|
10536
12520
|
}>;
|
|
10537
12521
|
/**
|
|
@@ -10561,9 +12545,18 @@ type ListAlertsResponses = {
|
|
|
10561
12545
|
type ListAlertsResponse = ListAlertsResponses[keyof ListAlertsResponses];
|
|
10562
12546
|
type CreateAlertData = {
|
|
10563
12547
|
body: {
|
|
12548
|
+
/**
|
|
12549
|
+
* Rule name.
|
|
12550
|
+
*/
|
|
10564
12551
|
name: string;
|
|
12552
|
+
/**
|
|
12553
|
+
* false: the rule sends nothing. Default true.
|
|
12554
|
+
*/
|
|
10565
12555
|
enabled?: boolean;
|
|
10566
12556
|
mode?: 'instant' | 'hourly' | 'daily' | 'weekly';
|
|
12557
|
+
/**
|
|
12558
|
+
* Which mentions the rule sends. Default: every relevant mention.
|
|
12559
|
+
*/
|
|
10567
12560
|
filter?: {
|
|
10568
12561
|
/**
|
|
10569
12562
|
* Only these keywords.
|
|
@@ -10605,6 +12598,14 @@ type CreateAlertData = {
|
|
|
10605
12598
|
* Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
|
|
10606
12599
|
*/
|
|
10607
12600
|
tags?: Array<string>;
|
|
12601
|
+
/**
|
|
12602
|
+
* Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
|
|
12603
|
+
*/
|
|
12604
|
+
labels?: Array<string>;
|
|
12605
|
+
/**
|
|
12606
|
+
* Never mentions carrying any of these labels.
|
|
12607
|
+
*/
|
|
12608
|
+
notLabels?: Array<string>;
|
|
10608
12609
|
/**
|
|
10609
12610
|
* Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
|
|
10610
12611
|
*/
|
|
@@ -10670,9 +12671,21 @@ type CreateAlertData = {
|
|
|
10670
12671
|
* Required for daily and weekly alerts (weekly ones also need schedule.weekday). Hourly alerts take none: they send every UTC hour, so a time of day and a zone are ignored and a weekday is refused.
|
|
10671
12672
|
*/
|
|
10672
12673
|
schedule?: {
|
|
12674
|
+
/**
|
|
12675
|
+
* Hour of the day to send, 0 to 23, in timezone.
|
|
12676
|
+
*/
|
|
10673
12677
|
hour: number;
|
|
12678
|
+
/**
|
|
12679
|
+
* Minute past the hour, 0 to 59.
|
|
12680
|
+
*/
|
|
10674
12681
|
minute?: number;
|
|
12682
|
+
/**
|
|
12683
|
+
* IANA zone the schedule runs in (Europe/Madrid).
|
|
12684
|
+
*/
|
|
10675
12685
|
timezone: string;
|
|
12686
|
+
/**
|
|
12687
|
+
* true: send nothing when the window had no mention.
|
|
12688
|
+
*/
|
|
10676
12689
|
skipEmpty?: boolean;
|
|
10677
12690
|
/**
|
|
10678
12691
|
* Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
|
|
@@ -10718,6 +12731,12 @@ type CreateAlertResponses = {
|
|
|
10718
12731
|
type CreateAlertResponse = CreateAlertResponses[keyof CreateAlertResponses];
|
|
10719
12732
|
type TestAlertData = {
|
|
10720
12733
|
body?: never;
|
|
12734
|
+
headers?: {
|
|
12735
|
+
/**
|
|
12736
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
12737
|
+
*/
|
|
12738
|
+
'idempotency-key'?: string;
|
|
12739
|
+
};
|
|
10721
12740
|
path: {
|
|
10722
12741
|
/**
|
|
10723
12742
|
* Alert id (feed_...).
|
|
@@ -10743,9 +12762,21 @@ type TestAlertResponses = {
|
|
|
10743
12762
|
* A test message was attempted on every channel of the rule
|
|
10744
12763
|
*/
|
|
10745
12764
|
200: {
|
|
12765
|
+
/**
|
|
12766
|
+
* One result per channel of the rule.
|
|
12767
|
+
*/
|
|
10746
12768
|
outcomes: Array<{
|
|
12769
|
+
/**
|
|
12770
|
+
* The channel (dest_...).
|
|
12771
|
+
*/
|
|
10747
12772
|
channelId: string;
|
|
12773
|
+
/**
|
|
12774
|
+
* Whether the channel accepted it.
|
|
12775
|
+
*/
|
|
10748
12776
|
ok: boolean;
|
|
12777
|
+
/**
|
|
12778
|
+
* Why it failed; null when it did not.
|
|
12779
|
+
*/
|
|
10749
12780
|
error: string | null;
|
|
10750
12781
|
}>;
|
|
10751
12782
|
};
|
|
@@ -10753,6 +12784,12 @@ type TestAlertResponses = {
|
|
|
10753
12784
|
type TestAlertResponse = TestAlertResponses[keyof TestAlertResponses];
|
|
10754
12785
|
type RunAlertDigestData = {
|
|
10755
12786
|
body?: never;
|
|
12787
|
+
headers?: {
|
|
12788
|
+
/**
|
|
12789
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
12790
|
+
*/
|
|
12791
|
+
'idempotency-key'?: string;
|
|
12792
|
+
};
|
|
10756
12793
|
path: {
|
|
10757
12794
|
/**
|
|
10758
12795
|
* Alert id (feed_...).
|
|
@@ -10786,11 +12823,29 @@ type RunAlertDigestResponses = {
|
|
|
10786
12823
|
* Why nothing was sent: the period already went out, nothing to show, an hourly retry window closed, or another run is sending it now.
|
|
10787
12824
|
*/
|
|
10788
12825
|
skipped: 'already_sent' | 'empty' | 'expired' | 'in_flight';
|
|
12826
|
+
/**
|
|
12827
|
+
* Matches in the window.
|
|
12828
|
+
*/
|
|
10789
12829
|
matched: number;
|
|
12830
|
+
/**
|
|
12831
|
+
* Relevant matches in the window.
|
|
12832
|
+
*/
|
|
10790
12833
|
relevant: number;
|
|
12834
|
+
/**
|
|
12835
|
+
* One result per channel.
|
|
12836
|
+
*/
|
|
10791
12837
|
outcomes: Array<{
|
|
12838
|
+
/**
|
|
12839
|
+
* The channel (dest_...).
|
|
12840
|
+
*/
|
|
10792
12841
|
channelId: string;
|
|
12842
|
+
/**
|
|
12843
|
+
* Whether the channel accepted it.
|
|
12844
|
+
*/
|
|
10793
12845
|
ok: boolean;
|
|
12846
|
+
/**
|
|
12847
|
+
* Why it failed; null when it did not.
|
|
12848
|
+
*/
|
|
10794
12849
|
error: string | null;
|
|
10795
12850
|
}>;
|
|
10796
12851
|
};
|
|
@@ -10806,6 +12861,12 @@ type MuteAlertAuthorsData = {
|
|
|
10806
12861
|
*/
|
|
10807
12862
|
authors: Array<string>;
|
|
10808
12863
|
};
|
|
12864
|
+
headers?: {
|
|
12865
|
+
/**
|
|
12866
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
12867
|
+
*/
|
|
12868
|
+
'idempotency-key'?: string;
|
|
12869
|
+
};
|
|
10809
12870
|
path: {
|
|
10810
12871
|
/**
|
|
10811
12872
|
* Alert id (feed_...).
|
|
@@ -10847,6 +12908,12 @@ type UnmuteAlertAuthorsData = {
|
|
|
10847
12908
|
*/
|
|
10848
12909
|
authors: Array<string>;
|
|
10849
12910
|
};
|
|
12911
|
+
headers?: {
|
|
12912
|
+
/**
|
|
12913
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
12914
|
+
*/
|
|
12915
|
+
'idempotency-key'?: string;
|
|
12916
|
+
};
|
|
10850
12917
|
path: {
|
|
10851
12918
|
/**
|
|
10852
12919
|
* Alert id (feed_...).
|
|
@@ -10857,6 +12924,10 @@ type UnmuteAlertAuthorsData = {
|
|
|
10857
12924
|
url: '/v1/alerts/{id}/unmute';
|
|
10858
12925
|
};
|
|
10859
12926
|
type UnmuteAlertAuthorsErrors = {
|
|
12927
|
+
/**
|
|
12928
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
12929
|
+
*/
|
|
12930
|
+
400: ErrorResponse;
|
|
10860
12931
|
/**
|
|
10861
12932
|
* Missing or invalid API key
|
|
10862
12933
|
*/
|
|
@@ -10898,6 +12969,14 @@ type GetAnalyticsSummaryData = {
|
|
|
10898
12969
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
10899
12970
|
*/
|
|
10900
12971
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
12972
|
+
/**
|
|
12973
|
+
* Never these keyword ids. Repeatable, or comma-separated.
|
|
12974
|
+
*/
|
|
12975
|
+
notKeywordIds?: Array<string> | null;
|
|
12976
|
+
/**
|
|
12977
|
+
* Never these platforms. Repeatable, or comma-separated.
|
|
12978
|
+
*/
|
|
12979
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10901
12980
|
/**
|
|
10902
12981
|
* true adds the period of the same length right before the window as `previous`.
|
|
10903
12982
|
*/
|
|
@@ -10951,6 +13030,14 @@ type GetAnalyticsSeriesData = {
|
|
|
10951
13030
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
10952
13031
|
*/
|
|
10953
13032
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
13033
|
+
/**
|
|
13034
|
+
* Never these keyword ids. Repeatable, or comma-separated.
|
|
13035
|
+
*/
|
|
13036
|
+
notKeywordIds?: Array<string> | null;
|
|
13037
|
+
/**
|
|
13038
|
+
* Never these platforms. Repeatable, or comma-separated.
|
|
13039
|
+
*/
|
|
13040
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
10954
13041
|
/**
|
|
10955
13042
|
* true adds the period of the same length right before the window as `previous`.
|
|
10956
13043
|
*/
|
|
@@ -11012,6 +13099,14 @@ type GetAnalyticsBreakdownData = {
|
|
|
11012
13099
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
11013
13100
|
*/
|
|
11014
13101
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
13102
|
+
/**
|
|
13103
|
+
* Never these keyword ids. Repeatable, or comma-separated.
|
|
13104
|
+
*/
|
|
13105
|
+
notKeywordIds?: Array<string> | null;
|
|
13106
|
+
/**
|
|
13107
|
+
* Never these platforms. Repeatable, or comma-separated.
|
|
13108
|
+
*/
|
|
13109
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
11015
13110
|
/**
|
|
11016
13111
|
* true adds the period of the same length right before the window as `previous`.
|
|
11017
13112
|
*/
|
|
@@ -11079,6 +13174,14 @@ type GetShareOfVoiceData = {
|
|
|
11079
13174
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
11080
13175
|
*/
|
|
11081
13176
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
13177
|
+
/**
|
|
13178
|
+
* Never these keyword ids. Repeatable, or comma-separated.
|
|
13179
|
+
*/
|
|
13180
|
+
notKeywordIds?: Array<string> | null;
|
|
13181
|
+
/**
|
|
13182
|
+
* Never these platforms. Repeatable, or comma-separated.
|
|
13183
|
+
*/
|
|
13184
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
11082
13185
|
/**
|
|
11083
13186
|
* true adds the period of the same length right before the window as `previous`.
|
|
11084
13187
|
*/
|
|
@@ -11132,6 +13235,14 @@ type GetReviewsReportData = {
|
|
|
11132
13235
|
* Only these platforms. Repeatable, or comma-separated; omit for every platform.
|
|
11133
13236
|
*/
|
|
11134
13237
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
13238
|
+
/**
|
|
13239
|
+
* Never these keyword ids. Repeatable, or comma-separated.
|
|
13240
|
+
*/
|
|
13241
|
+
notKeywordIds?: Array<string> | null;
|
|
13242
|
+
/**
|
|
13243
|
+
* Never these platforms. Repeatable, or comma-separated.
|
|
13244
|
+
*/
|
|
13245
|
+
notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
11135
13246
|
/**
|
|
11136
13247
|
* true adds the period of the same length right before the window as `previous`.
|
|
11137
13248
|
*/
|
|
@@ -11228,6 +13339,9 @@ type UpdateChannelData = {
|
|
|
11228
13339
|
* Omitted fields are untouched.
|
|
11229
13340
|
*/
|
|
11230
13341
|
body: {
|
|
13342
|
+
/**
|
|
13343
|
+
* Your name for the channel.
|
|
13344
|
+
*/
|
|
11231
13345
|
label?: string;
|
|
11232
13346
|
/**
|
|
11233
13347
|
* Webhooks only.
|
|
@@ -11277,6 +13391,12 @@ type UpdateChannelResponses = {
|
|
|
11277
13391
|
type UpdateChannelResponse = UpdateChannelResponses[keyof UpdateChannelResponses];
|
|
11278
13392
|
type TestChannelData = {
|
|
11279
13393
|
body?: never;
|
|
13394
|
+
headers?: {
|
|
13395
|
+
/**
|
|
13396
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
13397
|
+
*/
|
|
13398
|
+
'idempotency-key'?: string;
|
|
13399
|
+
};
|
|
11280
13400
|
path: {
|
|
11281
13401
|
/**
|
|
11282
13402
|
* Channel id (dest_...).
|
|
@@ -11302,9 +13422,21 @@ type TestChannelResponses = {
|
|
|
11302
13422
|
* A test message was attempted on the channel (webhooks receive event "test")
|
|
11303
13423
|
*/
|
|
11304
13424
|
200: {
|
|
13425
|
+
/**
|
|
13426
|
+
* The test send's result.
|
|
13427
|
+
*/
|
|
11305
13428
|
outcomes: Array<{
|
|
13429
|
+
/**
|
|
13430
|
+
* The channel (dest_...).
|
|
13431
|
+
*/
|
|
11306
13432
|
channelId: string;
|
|
13433
|
+
/**
|
|
13434
|
+
* Whether the channel accepted it.
|
|
13435
|
+
*/
|
|
11307
13436
|
ok: boolean;
|
|
13437
|
+
/**
|
|
13438
|
+
* Why it failed; null when it did not.
|
|
13439
|
+
*/
|
|
11308
13440
|
error: string | null;
|
|
11309
13441
|
}>;
|
|
11310
13442
|
};
|
|
@@ -11312,6 +13444,12 @@ type TestChannelResponses = {
|
|
|
11312
13444
|
type TestChannelResponse = TestChannelResponses[keyof TestChannelResponses];
|
|
11313
13445
|
type RotateWebhookSecretData = {
|
|
11314
13446
|
body?: never;
|
|
13447
|
+
headers?: {
|
|
13448
|
+
/**
|
|
13449
|
+
* A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
|
|
13450
|
+
*/
|
|
13451
|
+
'idempotency-key'?: string;
|
|
13452
|
+
};
|
|
11315
13453
|
path: {
|
|
11316
13454
|
/**
|
|
11317
13455
|
* Channel id (dest_...).
|
|
@@ -11360,6 +13498,10 @@ type ListChannelDeliveriesData = {
|
|
|
11360
13498
|
url: '/v1/channels/{id}/deliveries';
|
|
11361
13499
|
};
|
|
11362
13500
|
type ListChannelDeliveriesErrors = {
|
|
13501
|
+
/**
|
|
13502
|
+
* Invalid request: a parameter or the body failed validation (validation_error)
|
|
13503
|
+
*/
|
|
13504
|
+
400: ErrorResponse;
|
|
11363
13505
|
/**
|
|
11364
13506
|
* Missing or invalid API key
|
|
11365
13507
|
*/
|
|
@@ -11375,6 +13517,9 @@ type ListChannelDeliveriesResponses = {
|
|
|
11375
13517
|
* What the channel received, newest first: instant mentions and digest runs, with status and last error
|
|
11376
13518
|
*/
|
|
11377
13519
|
200: {
|
|
13520
|
+
/**
|
|
13521
|
+
* Deliveries, newest first.
|
|
13522
|
+
*/
|
|
11378
13523
|
data: Array<{
|
|
11379
13524
|
/**
|
|
11380
13525
|
* Delivery id (dlv_...), also the webhook payload id.
|
|
@@ -11388,7 +13533,13 @@ type ListChannelDeliveriesResponses = {
|
|
|
11388
13533
|
* The event name the payload carried: the rule's (mention.matched unless it set one, digest for a summary) or the account event's.
|
|
11389
13534
|
*/
|
|
11390
13535
|
event: string;
|
|
13536
|
+
/**
|
|
13537
|
+
* pending, delivered or failed.
|
|
13538
|
+
*/
|
|
11391
13539
|
status: 'pending' | 'delivered' | 'failed';
|
|
13540
|
+
/**
|
|
13541
|
+
* Send attempts so far.
|
|
13542
|
+
*/
|
|
11392
13543
|
attempts: number;
|
|
11393
13544
|
/**
|
|
11394
13545
|
* The last failure, when there was one.
|
|
@@ -11406,14 +13557,26 @@ type ListChannelDeliveriesResponses = {
|
|
|
11406
13557
|
* The alert that produced it; name only, since alerts can be deleted. name is null for an account event, which no rule produces.
|
|
11407
13558
|
*/
|
|
11408
13559
|
alert: {
|
|
13560
|
+
/**
|
|
13561
|
+
* Alert name.
|
|
13562
|
+
*/
|
|
11409
13563
|
name: string | null;
|
|
11410
13564
|
};
|
|
11411
13565
|
/**
|
|
11412
13566
|
* For mention deliveries: the post, text cut to 160 characters.
|
|
11413
13567
|
*/
|
|
11414
13568
|
mention: {
|
|
13569
|
+
/**
|
|
13570
|
+
* Mention id.
|
|
13571
|
+
*/
|
|
11415
13572
|
id: string;
|
|
13573
|
+
/**
|
|
13574
|
+
* Link to the post.
|
|
13575
|
+
*/
|
|
11416
13576
|
url: string;
|
|
13577
|
+
/**
|
|
13578
|
+
* The post text, cut to 160 characters.
|
|
13579
|
+
*/
|
|
11417
13580
|
text: string;
|
|
11418
13581
|
} | null;
|
|
11419
13582
|
}>;
|
|
@@ -11442,6 +13605,9 @@ type ListChannelsResponses = {
|
|
|
11442
13605
|
* Every channel of the org
|
|
11443
13606
|
*/
|
|
11444
13607
|
200: {
|
|
13608
|
+
/**
|
|
13609
|
+
* Every channel of the workspace.
|
|
13610
|
+
*/
|
|
11445
13611
|
data: Array<SlackChannel | EmailChannel | WebhookChannel | TelegramChannel>;
|
|
11446
13612
|
};
|
|
11447
13613
|
};
|
|
@@ -11624,6 +13790,16 @@ declare const getFilters: <ThrowOnError extends boolean = false>(options?: Optio
|
|
|
11624
13790
|
* Entries are stored canonically (lowercase terms, authors as profile links or names, owner/name repositories, subreddits without r/). Applies to new mentions within a minute.
|
|
11625
13791
|
*/
|
|
11626
13792
|
declare const updateFilters: <ThrowOnError extends boolean = false>(options: Options<UpdateFiltersData, ThrowOnError>) => RequestResult<UpdateFiltersResponses, UpdateFiltersErrors, ThrowOnError>;
|
|
13793
|
+
/**
|
|
13794
|
+
* Update many mentions
|
|
13795
|
+
*
|
|
13796
|
+
* Change up to 100 mentions at once: status, assignee, labels to add or remove.
|
|
13797
|
+
*
|
|
13798
|
+
* - All of it lands, or none of it.
|
|
13799
|
+
* - Unknown ids come back in `notFound`.
|
|
13800
|
+
* - Removals run before additions. See [Labels and automations](/guides/labels).
|
|
13801
|
+
*/
|
|
13802
|
+
declare const updateMentions: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionsData, ThrowOnError>) => RequestResult<UpdateMentionsResponses, UpdateMentionsErrors, ThrowOnError>;
|
|
11627
13803
|
/**
|
|
11628
13804
|
* Get a mention
|
|
11629
13805
|
*
|
|
@@ -11635,9 +13811,10 @@ declare const getMention: <ThrowOnError extends boolean = false>(options: Option
|
|
|
11635
13811
|
/**
|
|
11636
13812
|
* Update a mention
|
|
11637
13813
|
*
|
|
11638
|
-
* Triage, assign, snooze, annotate or correct the classification of a mention.
|
|
13814
|
+
* Triage, assign, snooze, label, annotate or correct the classification of a mention.
|
|
11639
13815
|
*
|
|
11640
|
-
* - `relevant` and `sentiment` are your verdict;
|
|
13816
|
+
* - `relevant` and `sentiment` are your verdict; null restores the classifier's.
|
|
13817
|
+
* - `labels` replaces the whole list.
|
|
11641
13818
|
* - Omitted fields stay. Delivery and billing never change.
|
|
11642
13819
|
*/
|
|
11643
13820
|
declare const updateMention: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionData, ThrowOnError>) => RequestResult<UpdateMentionResponses, UpdateMentionErrors, ThrowOnError>;
|
|
@@ -11831,6 +14008,45 @@ declare const getView: <ThrowOnError extends boolean = false>(options: Options<G
|
|
|
11831
14008
|
* Rename, describe or refilter a view. `filter` replaces the whole filter.
|
|
11832
14009
|
*/
|
|
11833
14010
|
declare const updateView: <ThrowOnError extends boolean = false>(options: Options<UpdateViewData, ThrowOnError>) => RequestResult<UpdateViewResponses, UpdateViewErrors, ThrowOnError>;
|
|
14011
|
+
/**
|
|
14012
|
+
* List automations
|
|
14013
|
+
*
|
|
14014
|
+
* The workspace's automations, in the order they run, oldest first. See [Labels and automations](/guides/labels).
|
|
14015
|
+
*/
|
|
14016
|
+
declare const listAutomations: <ThrowOnError extends boolean = false>(options?: Options<ListAutomationsData, ThrowOnError>) => RequestResult<ListAutomationsResponses, ListAutomationsErrors, ThrowOnError>;
|
|
14017
|
+
/**
|
|
14018
|
+
* Create an automation
|
|
14019
|
+
*
|
|
14020
|
+
* Act on every new mention a filter selects: add labels, assign a member.
|
|
14021
|
+
*
|
|
14022
|
+
* - Runs after scoring and before delivery, so alert rules see its labels.
|
|
14023
|
+
* - At most 25. Existing mentions are untouched; use POST /v1/mentions/batch. See [Labels and automations](/guides/labels).
|
|
14024
|
+
*/
|
|
14025
|
+
declare const createAutomation: <ThrowOnError extends boolean = false>(options: Options<CreateAutomationData, ThrowOnError>) => RequestResult<CreateAutomationResponses, CreateAutomationErrors, ThrowOnError>;
|
|
14026
|
+
/**
|
|
14027
|
+
* Delete an automation
|
|
14028
|
+
*
|
|
14029
|
+
* Removes the automation. The labels it added stay on their mentions.
|
|
14030
|
+
*/
|
|
14031
|
+
declare const deleteAutomation: <ThrowOnError extends boolean = false>(options: Options<DeleteAutomationData, ThrowOnError>) => RequestResult<DeleteAutomationResponses, DeleteAutomationErrors, ThrowOnError>;
|
|
14032
|
+
/**
|
|
14033
|
+
* Get an automation
|
|
14034
|
+
*/
|
|
14035
|
+
declare const getAutomation: <ThrowOnError extends boolean = false>(options: Options<GetAutomationData, ThrowOnError>) => RequestResult<GetAutomationResponses, GetAutomationErrors, ThrowOnError>;
|
|
14036
|
+
/**
|
|
14037
|
+
* Update an automation
|
|
14038
|
+
*
|
|
14039
|
+
* Rename, pause or change an automation. `filter` and `actions` each replace the whole of themselves. A change applies to mentions scored from then on.
|
|
14040
|
+
*/
|
|
14041
|
+
declare const updateAutomation: <ThrowOnError extends boolean = false>(options: Options<UpdateAutomationData, ThrowOnError>) => RequestResult<UpdateAutomationResponses, UpdateAutomationErrors, ThrowOnError>;
|
|
14042
|
+
/**
|
|
14043
|
+
* List labels
|
|
14044
|
+
*
|
|
14045
|
+
* Labels in the workspace and how many mentions carry each, the most used first.
|
|
14046
|
+
*
|
|
14047
|
+
* A label exists while a mention carries it. Filter mentions with `labels` / `notLabels`.
|
|
14048
|
+
*/
|
|
14049
|
+
declare const listLabels: <ThrowOnError extends boolean = false>(options?: Options<ListLabelsData, ThrowOnError>) => RequestResult<ListLabelsResponses, ListLabelsErrors, ThrowOnError>;
|
|
11834
14050
|
/**
|
|
11835
14051
|
* List attention items
|
|
11836
14052
|
*
|
|
@@ -12143,6 +14359,7 @@ declare const createChannel: <ThrowOnError extends boolean = false>(options: Opt
|
|
|
12143
14359
|
type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options<TData, ThrowOnError, TResponse>;
|
|
12144
14360
|
declare const sdk_createAlert: typeof createAlert;
|
|
12145
14361
|
declare const sdk_createApiKey: typeof createApiKey;
|
|
14362
|
+
declare const sdk_createAutomation: typeof createAutomation;
|
|
12146
14363
|
declare const sdk_createChannel: typeof createChannel;
|
|
12147
14364
|
declare const sdk_createFeed: typeof createFeed;
|
|
12148
14365
|
declare const sdk_createGroup: typeof createGroup;
|
|
@@ -12152,6 +14369,7 @@ declare const sdk_createSegment: typeof createSegment;
|
|
|
12152
14369
|
declare const sdk_createTopUp: typeof createTopUp;
|
|
12153
14370
|
declare const sdk_createView: typeof createView;
|
|
12154
14371
|
declare const sdk_deleteAlert: typeof deleteAlert;
|
|
14372
|
+
declare const sdk_deleteAutomation: typeof deleteAutomation;
|
|
12155
14373
|
declare const sdk_deleteChannel: typeof deleteChannel;
|
|
12156
14374
|
declare const sdk_deleteFeed: typeof deleteFeed;
|
|
12157
14375
|
declare const sdk_deleteGroup: typeof deleteGroup;
|
|
@@ -12168,6 +14386,7 @@ declare const sdk_getAlert: typeof getAlert;
|
|
|
12168
14386
|
declare const sdk_getAnalyticsBreakdown: typeof getAnalyticsBreakdown;
|
|
12169
14387
|
declare const sdk_getAnalyticsSeries: typeof getAnalyticsSeries;
|
|
12170
14388
|
declare const sdk_getAnalyticsSummary: typeof getAnalyticsSummary;
|
|
14389
|
+
declare const sdk_getAutomation: typeof getAutomation;
|
|
12171
14390
|
declare const sdk_getChannel: typeof getChannel;
|
|
12172
14391
|
declare const sdk_getCompany: typeof getCompany;
|
|
12173
14392
|
declare const sdk_getFeed: typeof getFeed;
|
|
@@ -12190,6 +14409,7 @@ declare const sdk_importFeeds: typeof importFeeds;
|
|
|
12190
14409
|
declare const sdk_listAlerts: typeof listAlerts;
|
|
12191
14410
|
declare const sdk_listApiKeys: typeof listApiKeys;
|
|
12192
14411
|
declare const sdk_listAttention: typeof listAttention;
|
|
14412
|
+
declare const sdk_listAutomations: typeof listAutomations;
|
|
12193
14413
|
declare const sdk_listChannelDeliveries: typeof listChannelDeliveries;
|
|
12194
14414
|
declare const sdk_listChannels: typeof listChannels;
|
|
12195
14415
|
declare const sdk_listFeeds: typeof listFeeds;
|
|
@@ -12197,6 +14417,7 @@ declare const sdk_listGroups: typeof listGroups;
|
|
|
12197
14417
|
declare const sdk_listInvitations: typeof listInvitations;
|
|
12198
14418
|
declare const sdk_listInvoices: typeof listInvoices;
|
|
12199
14419
|
declare const sdk_listKeywords: typeof listKeywords;
|
|
14420
|
+
declare const sdk_listLabels: typeof listLabels;
|
|
12200
14421
|
declare const sdk_listLedger: typeof listLedger;
|
|
12201
14422
|
declare const sdk_listMembers: typeof listMembers;
|
|
12202
14423
|
declare const sdk_listMentionComments: typeof listMentionComments;
|
|
@@ -12219,6 +14440,7 @@ declare const sdk_testAlert: typeof testAlert;
|
|
|
12219
14440
|
declare const sdk_testChannel: typeof testChannel;
|
|
12220
14441
|
declare const sdk_unmuteAlertAuthors: typeof unmuteAlertAuthors;
|
|
12221
14442
|
declare const sdk_updateAlert: typeof updateAlert;
|
|
14443
|
+
declare const sdk_updateAutomation: typeof updateAutomation;
|
|
12222
14444
|
declare const sdk_updateChannel: typeof updateChannel;
|
|
12223
14445
|
declare const sdk_updateCompany: typeof updateCompany;
|
|
12224
14446
|
declare const sdk_updateFeed: typeof updateFeed;
|
|
@@ -12226,12 +14448,13 @@ declare const sdk_updateFilters: typeof updateFilters;
|
|
|
12226
14448
|
declare const sdk_updateGroup: typeof updateGroup;
|
|
12227
14449
|
declare const sdk_updateKeyword: typeof updateKeyword;
|
|
12228
14450
|
declare const sdk_updateMention: typeof updateMention;
|
|
14451
|
+
declare const sdk_updateMentions: typeof updateMentions;
|
|
12229
14452
|
declare const sdk_updatePerson: typeof updatePerson;
|
|
12230
14453
|
declare const sdk_updateSegment: typeof updateSegment;
|
|
12231
14454
|
declare const sdk_updateView: typeof updateView;
|
|
12232
14455
|
declare const sdk_whoami: typeof whoami;
|
|
12233
14456
|
declare namespace sdk {
|
|
12234
|
-
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createFeed as createFeed, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteFeed as deleteFeed, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_dismissAttention as dismissAttention, sdk_duplicateKeyword as duplicateKeyword, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFeed as getFeed, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_importFeeds as importFeeds, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listFeeds as listFeeds, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listMentionComments as listMentionComments, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegmentPresets as listSegmentPresets, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFeed as updateFeed, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
|
|
14457
|
+
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createAutomation as createAutomation, sdk_createChannel as createChannel, sdk_createFeed as createFeed, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteAutomation as deleteAutomation, sdk_deleteChannel as deleteChannel, sdk_deleteFeed as deleteFeed, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_dismissAttention as dismissAttention, sdk_duplicateKeyword as duplicateKeyword, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getAutomation as getAutomation, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFeed as getFeed, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_importFeeds as importFeeds, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listAutomations as listAutomations, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listFeeds as listFeeds, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLabels as listLabels, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listMentionComments as listMentionComments, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegmentPresets as listSegmentPresets, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateAutomation as updateAutomation, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFeed as updateFeed, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updateMentions as updateMentions, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
|
|
12235
14458
|
}
|
|
12236
14459
|
|
|
12237
14460
|
/**
|
|
@@ -12259,4 +14482,4 @@ type Mentio = typeof sdk & {
|
|
|
12259
14482
|
};
|
|
12260
14483
|
declare function createMentio(options: MentioOptions): Mentio;
|
|
12261
14484
|
|
|
12262
|
-
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type AttentionItem, type Channel, type ChannelFailingEventData, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateFeedData, type CreateFeedError, type CreateFeedErrors, type CreateFeedResponse, type CreateFeedResponses, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteFeedData, type DeleteFeedError, type DeleteFeedErrors, type DeleteFeedResponse, type DeleteFeedResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type DismissAttentionData, type DismissAttentionError, type DismissAttentionErrors, type DismissAttentionResponse, type DismissAttentionResponses, type DuplicateKeywordData, type DuplicateKeywordError, type DuplicateKeywordErrors, type DuplicateKeywordResponse, type DuplicateKeywordResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type Feed, type FeedFailingEventData, type FilterGroup, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFeedData, type GetFeedError, type GetFeedErrors, type GetFeedResponse, type GetFeedResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type ImportFeedsData, type ImportFeedsError, type ImportFeedsErrors, type ImportFeedsResponse, type ImportFeedsResponses, type Invitation, type InvoiceList, type Keyword, type KeywordFeed, type KeywordHealth, type KeywordNoisyEventData, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListAttentionData, type ListAttentionError, type ListAttentionErrors, type ListAttentionResponse, type ListAttentionResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListFeedsData, type ListFeedsError, type ListFeedsErrors, type ListFeedsResponse, type ListFeedsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListMentionCommentsData, type ListMentionCommentsError, type ListMentionCommentsErrors, type ListMentionCommentsResponse, type ListMentionCommentsResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentPresetsData, type ListSegmentPresetsError, type ListSegmentPresetsErrors, type ListSegmentPresetsResponse, type ListSegmentPresetsResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MentionComment, type MentionSpikeEventData, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type NegativeSpikeEventData, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type SegmentPreset, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFeedData, type UpdateFeedError, type UpdateFeedErrors, type UpdateFeedResponse, type UpdateFeedResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createFeed, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteFeed, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, duplicateKeyword, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFeed, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, importFeeds, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listFeeds, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSegmentPresets, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFeed, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|
|
14485
|
+
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type AttentionItem, type Automation, type Channel, type ChannelFailingEventData, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateAutomationData, type CreateAutomationError, type CreateAutomationErrors, type CreateAutomationResponse, type CreateAutomationResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateFeedData, type CreateFeedError, type CreateFeedErrors, type CreateFeedResponse, type CreateFeedResponses, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteAutomationData, type DeleteAutomationError, type DeleteAutomationErrors, type DeleteAutomationResponse, type DeleteAutomationResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteFeedData, type DeleteFeedError, type DeleteFeedErrors, type DeleteFeedResponse, type DeleteFeedResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type DismissAttentionData, type DismissAttentionError, type DismissAttentionErrors, type DismissAttentionResponse, type DismissAttentionResponses, type DuplicateKeywordData, type DuplicateKeywordError, type DuplicateKeywordErrors, type DuplicateKeywordResponse, type DuplicateKeywordResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type Feed, type FeedFailingEventData, type FilterGroup, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetAutomationData, type GetAutomationError, type GetAutomationErrors, type GetAutomationResponse, type GetAutomationResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFeedData, type GetFeedError, type GetFeedErrors, type GetFeedResponse, type GetFeedResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type ImportFeedsData, type ImportFeedsError, type ImportFeedsErrors, type ImportFeedsResponse, type ImportFeedsResponses, type Invitation, type InvoiceList, type Keyword, type KeywordFeed, type KeywordHealth, type KeywordNoisyEventData, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListAttentionData, type ListAttentionError, type ListAttentionErrors, type ListAttentionResponse, type ListAttentionResponses, type ListAutomationsData, type ListAutomationsError, type ListAutomationsErrors, type ListAutomationsResponse, type ListAutomationsResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListFeedsData, type ListFeedsError, type ListFeedsErrors, type ListFeedsResponse, type ListFeedsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLabelsData, type ListLabelsError, type ListLabelsErrors, type ListLabelsResponse, type ListLabelsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListMentionCommentsData, type ListMentionCommentsError, type ListMentionCommentsErrors, type ListMentionCommentsResponse, type ListMentionCommentsResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentPresetsData, type ListSegmentPresetsError, type ListSegmentPresetsErrors, type ListSegmentPresetsResponse, type ListSegmentPresetsResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MentionBatchResult, type MentionComment, type MentionSpikeEventData, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type NegativeSpikeEventData, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type SegmentPreset, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateAutomationData, type UpdateAutomationError, type UpdateAutomationErrors, type UpdateAutomationResponse, type UpdateAutomationResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFeedData, type UpdateFeedError, type UpdateFeedErrors, type UpdateFeedResponse, type UpdateFeedResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdateMentionsData, type UpdateMentionsError, type UpdateMentionsErrors, type UpdateMentionsResponse, type UpdateMentionsResponses, 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, createAutomation, createChannel, createClient, createConfig, createFeed, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteAutomation, deleteChannel, deleteFeed, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, duplicateKeyword, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getAutomation, getChannel, getCompany, getFeed, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, importFeeds, listAlerts, listApiKeys, listAttention, listAutomations, listChannelDeliveries, listChannels, listFeeds, listGroups, listInvitations, listInvoices, listKeywords, listLabels, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSegmentPresets, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateAutomation, updateChannel, updateCompany, updateFeed, updateFilters, updateGroup, updateKeyword, updateMention, updateMentions, updatePerson, updateSegment, updateView, whoami };
|