Twitter - search for tweets
Search form
Description - Returns a collection of relevant Tweets matching a specified query.
Runtime Class - com.ibi.agents.XDTwitterSearch
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * Query: string A UTF-8, URL-encoded search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity.
Locale: string Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.
Result Type: string Optional. Specifies what type of search results you would prefer to receive. The current default is 'mixed'. Valid values include: * mixed : Include both popular and real time results in the response. * recent : return only the most recent results in the response * popular : return only the most popular results in the response.
Select from one of the following options:
- mixed
- recent
- popular
* - denotes required
Parameter Type Description Max ID: string Returns results with an ID less than (that is, older than) or equal to the specified ID.
Language: string Restricts tweets to the given language, given by an ISO 639-1 two-letter code. Language detection is best-effort.
Since ID: string Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.
Count: integer The number of tweets to return per page, up to a maximum of 100. Defaults to 15. This was formerly the parameter in the old Search API.
Until: string Returns tweets created before the given date. Date should be formatted as YYYY-MM-DD. Keep in mind that the search index has a 7-day limit. In other words, no tweets will be found for a date older than one week.
Geocode: string Returns tweets by users located within a given radius of the given 'latitude,longitude'. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by 'latitude,longitude,radius', where radius units must be specified as either 'mi'(miles) or 'km'(kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct 'sub-regions' will be considered when using the radius modifier.
Radius: string The radius to be used in the geocode
Units: string The unit of measurement of the given radius. Can be 'mi'(miles) or 'km'(kilometers). Miles by default.
Select from one of the following options:
- mi
- km
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDTwitterSearch
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * Query: string A UTF-8, URL-encoded search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity.
Locale: string Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.
Result Type: string Optional. Specifies what type of search results you would prefer to receive. The current default is 'mixed'. Valid values include: * mixed : Include both popular and real time results in the response. * recent : return only the most recent results in the response * popular : return only the most popular results in the response.
Select from one of the following options:
- mixed
- recent
- popular
* - denotes required
Parameter Type Description Max ID: string Returns results with an ID less than (that is, older than) or equal to the specified ID.
Language: string Restricts tweets to the given language, given by an ISO 639-1 two-letter code. Language detection is best-effort.
Since ID: string Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.
Count: integer The number of tweets to return per page, up to a maximum of 100. Defaults to 15. This was formerly the parameter in the old Search API.
Until: string Returns tweets created before the given date. Date should be formatted as YYYY-MM-DD. Keep in mind that the search index has a 7-day limit. In other words, no tweets will be found for a date older than one week.
Geocode: string Returns tweets by users located within a given radius of the given 'latitude,longitude'. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by 'latitude,longitude,radius', where radius units must be specified as either 'mi'(miles) or 'km'(kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct 'sub-regions' will be considered when using the radius modifier.
Radius: string The radius to be used in the geocode
Units: string The unit of measurement of the given radius. Can be 'mi'(miles) or 'km'(kilometers). Miles by default.
Select from one of the following options:
- mi
- km
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | Query: | string | A UTF-8, URL-encoded search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity. | Locale: | string | Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases. | Result Type: | string | Optional. Specifies what type of search results you would prefer to receive. The current default is 'mixed'. Valid values include: * mixed : Include both popular and real time results in the response. * recent : return only the most recent results in the response * popular : return only the most popular results in the response.
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Max ID: | string | Returns results with an ID less than (that is, older than) or equal to the specified ID. | Language: | string | Restricts tweets to the given language, given by an ISO 639-1 two-letter code. Language detection is best-effort. | Since ID: | string | Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available. | Count: | integer | The number of tweets to return per page, up to a maximum of 100. Defaults to 15. This was formerly the parameter in the old Search API. | Until: | string | Returns tweets created before the given date. Date should be formatted as YYYY-MM-DD. Keep in mind that the search index has a 7-day limit. In other words, no tweets will be found for a date older than one week. | Geocode: | string | Returns tweets by users located within a given radius of the given 'latitude,longitude'. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by 'latitude,longitude,radius', where radius units must be specified as either 'mi'(miles) or 'km'(kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct 'sub-regions' will be considered when using the radius modifier. | Radius: | string | The radius to be used in the geocode | Units: | string | The unit of measurement of the given radius. Can be 'mi'(miles) or 'km'(kilometers). Miles by default.
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| onFailConnect | Could not connect to Twitter. |
| onFailParse | Could not parse a document. |
| onFailTwitterException | Twitter threw an exception. |
| onFailTwitterOperation | Could not perform the Twitter operation requested. |