Enterprise operators
Below is a list of all operators supported in X's enterprise search APIs:
- Enterprise 30-day search API
- Enterprise Full-archive search API
For a side-by-side comparison of available operators by product see HERE.
Operator | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
keyword |
Matches a tokenized keyword within the body or urls of a Post. This is a tokenized match, meaning that your keyword string will be matched against the tokenized text of the Post body – tokenization is based on punctuation, symbol, and separator Unicode basic plane characters. For example, a Post with the text “I like coca-cola” would be split into the following tokens: I, like, coca, cola. These tokens would then be compared to the keyword string used in your rule. To match strings containing punctuation (for example, coca-cola), symbol, or separator characters, you must use a quoted exact match as described below. Note: With the Search API, accented and special characters are normalized to standard latin characters, which can change meanings in foreign languages or return unexpected results: For example, "músic" will match “music” and vice versa. Note: This operator will match on both URLs and unwound URLs within a Post. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
emoji |
Matches an emoji within the body of a Post. Emojis are a tokenized match, meaning that your emoji will be matched against the tokenized text of the Post body – tokenization is based on punctuation, symbol/emoji, and separator Unicode basic plane characters. For example, a Post with the text “I like 🍕” would be split into the following tokens: I, like, 🍕. These tokens would then be compared to the emoji used in your rule. Note that if an emoji has a variant, you must use “quotations” to add to a rule. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
"exact phrase match" |
Matches the tokenized and ordered phrase within the body or urls of a Post. This is a tokenized match, meaning that your keyword string will be matched against the tokenized text of the Post body – tokenization is based on punctuation, symbol, and separator Unicode basic plane characters. Note: Punctuation is not tokenized and is instead treated as whitespace. Note: This operator will match on both URLs and unwound URLs within a Post. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
"keyword1 keyword2"~N |
Commonly referred to as a proximity operator, this matches a Post where the keywords are no more than N tokens from each other. If the keywords are in the opposite order, they can not be more than N-2 tokens from each other. Can have any number of keywords in quotes. N cannot be greater than 6. Note that this operator is only available in the enterprise search APIs. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from: |
Matches any Post from a specific user. The value must be the user’s X numeric Account ID or username (excluding the @ character). See HERE or HERE for methods for looking up numeric X Account IDs. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to: |
Matches any Post that is in reply to a particular user. The value must be the user’s numeric Account ID or username (excluding the @ character). See HERE for methods for looking up numeric X Account IDs. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
url: |
Performs a tokenized (keyword/phrase) match on the expanded URLs of a Post (similar to url_contains). Tokens and phrases containing punctuation or special characters should be double-quoted. For example, url:"/developer". While generally not recommended, if you want to match on a specific protocol, enclose in double-quotes: url:"https://developer.x.com". Note: When using PowerTrack or Historical PowerTrack, this operator will match on URLs contained within the original Post of a Quote Post. For example, if your rule includes url:"developer.x.com", and a Post contains that URL, any Quote Tweets of that Post will be included in the results. This is not the case when using the Search API. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
# |
Matches any Post with the given hashtag. This operator performs an exact match, NOT a tokenized match, meaning the rule “2016” will match posts with the exact hashtag “2016”, but not those with the hashtag “2016election” Note: that the hashtag operator relies on X's entity extraction to match hashtags, rather than extracting the hashtag from the body itself. See HERE for more information on X Entities JSON attributes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@ |
Matches any Post that mentions the given username. The to: operator returns a subset match of the @mention operator. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
$ | Matches any Post that contains the specified ‘cashtag’ (where the leading character of the token is the ‘$’ character). Note that the cashtag operator relies on X's ‘symbols’ entity extraction to match cashtags, rather than trying to extract the cashtag from the body itself. See HERE for more information on X Entities JSON attributes. Note that this operator is only available in the enterprise search APIs. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retweets_of: |
Available alias: retweets_of_user: Matches Posts that are retweets of a specified user. Accepts both usernames and numeric X Account IDs (NOT Post status IDs). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lang: |
Matches Posts that have been classified by X as being of a particular language (if, and only if, the post has been classified). It is important to note that each Post is currently only classified as being of one language, so AND’ing together multiple languages will yield no results. Note: if no language classification can be made the provided result is ‘und’ (for undefined). The list below represents the current supported languages and their corresponding BCP 47 language indentifier:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
place: |
Matches Posts tagged with the specified location or X place ID (see examples). Multi-word place names (“New York City”, “Palo Alto”) should be enclosed in quotes. Note: See the GET geo/search public API endpoint for how to obtain X place IDs. Note: This operator will not match on Retweets, since Retweet's places are attached to the original Post. It will also not match on places attached to the original Post of a Quote Tweet. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
place_country: |
Matches Posts where the country code associated with a tagged place matches the given ISO alpha-2 character code. Valid ISO codes can be found here: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 Note: This operator will not match on Retweets, since Retweet's places are attached to the original Post. It will also not match on places attached to the original Post of a Quote Tweet. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
point_radius:[lon lat radius] |
Matches against the Exact Location (x,y) of the Post when present, and in X, against a “Place” geo polygon, where the Place is fully contained within the defined region.
Note: This operator will not match on Retweets, since Retweet's places are attached to the original Post. It will also not match on places attached to the original Post of a Quote Tweet. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bounding_box:[west_long south_lat east_long north_lat] |
Available alias: geo_bounding_box: Matches against the Exact Location (long, lat) of the Post when present, and in X, against a “Place” geo polygon, where the Place is fully contained within the defined region.
Note: This operator will not match on Retweets, since Retweet's places are attached to the original Post. It will also not match on places attached to the original Post of a Quote Tweet. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
profile_country: |
Exact match on the “countryCode” field from the “address” object in the Profile Geo enrichment. Uses a normalized set of two-letter country codes, based on ISO-3166-1-alpha-2 specification. This operator is provided in lieu of an operator for “country” field from the “address” object to be concise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
profile_region: |
Matches on the “region” field from the “address” object in the Profile Geo enrichment. This is an exact full string match. It is not necessary to escape characters with a backslash. For example, if matching something with a slash, use “one/two”, not “one\/two”. Use double quotes to match substrings that contain whitespace or punctuation. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
profile_locality: |
Matches on the “locality” field from the “address” object in the Profile Geo enrichment. This is an exact full string match. It is not necessary to escape characters with a backslash. For example, if matching something with a slash, use “one/two”, not “one\/two”. Use double quotes to match substrings that contain whitespace or punctuation. |
NOTE: All is: and has: operators cannot be used as standalone operators when using the Search API, and must be combined with another clause.
For example, @XDeevelopers has:links
has:geo |
Matches Posts that have Post-specific geo location data provided from X. This can be either “geo” lat-long coordinate, or a “location” in the form of a X “Place”, with corresponding display name, geo polygon, and other fields. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
has:profile_geo |
Available alias: has:derived_user_geo Matches Posts that have any Profile Geo metadata, regardless of the actual value. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include
|
has:links |
This operators matches Posts which contain links in the message body. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
is:retweet |
Deliver only explicit retweets that match a rule. Can also be negated to exclude retweets that match a rule from delivery and only original content is delivered. This operator looks only for true Retweets, which use X's retweet functionality. Quoted Tweets and Modified Posst which do not use X's retweet functionality will not be matched by this operator. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
is:reply |
An operator to filter Posts based on whether they are or are not replies to Posts. Deliver only explicit replies that match a rule. Can also be negated to exclude replies that match a rule from delivery. Note that this operator is available for paid premium and enterprise search and is not available in Sandbox dev environments. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
is:quote | Delivers only Quote Tweets, or Posts that reference another Post, as identified by the "is_quote_status":true in Post payloads. Can also be negated to exclude Quote Tweets. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
is:verified |
Deliver only Posts where the author is “verified” by X. Can also be negated to exclude Posts where the author is verified. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
has:mentions |
Matches Posts that mention another X user. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
has:hashtags |
Matches Posts that contain a hashtag. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
has:media |
Available alias: has:media_link Matches Posts that contain a media url classified by X. For example, pic.x.com. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include
|
has:images |
Matches Posts that contain a media url classified by X. For example, pic.x.com. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |
has:videos |
Available alias: has:video_link Matches Posts that contain native X videos, uploaded directly to X. This will not match on videos created with Vine, Periscope, or Posts with links to other video hosting sites. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include
|
has:symbols |
Matches Posts that contain a cashtag symbol (with a leading ‘$’ character. For example, $tag). Note that this operator is only available in the enterprise search APIs. Note: When using the Search API, this operator must be used in conjunction with other operators that don't include |