Create Active Search

This method creates new active search for current user.

Creating of a new active search follows user account limitations.

If account is Pro, user can have:
- max 10000 active searches
If account is Premium, user can have:
- max 20 active searches
- not allowed to create public/global active search
If account is Supporter, user can have:
- 1 active search only
- not allowed to create public/global active search

Request:
Accepted are only POST requests

POST https://www.inoreader.com/reader/api/0/active_search/create

Request parameters:
JSON object of the active search with structure:

Example of POST payload:

{
    "term": "amazing",
    "filter_type": "subscription",
    "filter_id": "feed/http://dnes.dir.bg/support/cat_rss.php?section=glavnite",
    "article_ids": [12363668564,12361058806,12329220375,12314369383],
    "search_filters": "all",
    "search_match": "all_words"
}

Detailed description:

term - (mandatory) - keyword or phrase to search for. It becomes title of active search
filter_type - (mandatory) - expects one of values from ["folder", "subscription", "public"]
filter_id - (mandatory if filter_type != "public") - long format ID of filter_type
article_ids - (optional) - Array of articles ids. Accepts empty arrays.
search_filters - (optional) - expects one of values from ["all", "titles", "contents"]. Default = "all"
search_match - (optional) - expects one of values from ["all_words", "any_word", "full_phrase", "advanced"]. Default = "all_words"
search_feed_popularity - (optional) - expects one of values from ["all_sites", "popular_sites", "most_popular_sites"]. Default = "all_sites". Property is in effect only if filter_type = "public"

Response HTTP codes. Response messages are in the body:

- 200 - {"id":"user\/1005921515\/label\/term_title3","title":"term_title3"}.
- 400 - Typical API errors :
- 202 - JSON response with "error", full detailed object with errors during process of validation. If creation failed because of:

If max amount of active searches for account is reached - additional key "accountLimit" is added to response with value integer.
If it's an user friendly error - key 'userOutput' is added with value "1". In that case "error" string is localized (will be translated to user language).
If an error is because of some limitation to the user plan - key 'needUpgrade' is added with value "1".

← Back