All API URLs listed here must be prefixed by the root API URL.
Example: http://domain.com/kb/ or https://kb.domain.com/
Search Articles
GET api.php?call=articles&method=search
Arguments:
- q (optional) - A free text search. A UTF-8, URL-encoded search query of 1,000 characters maximum, including operators.
- in (optional) - Search mode. Specifies how to search. If this argument is omitted, it defaults to article.
Valid values include:
- article (search in article title, article body, meta keywords, meta description).
- article_title (search in article title only).
- article_keyword (by tags). Use a comma-delimited list of tags for q argument.
- article_id (by article id). Use a comma-delimited list of article id for q argument.
- article_author_id (by author id). Use a comma-delimited list of article id for q argument.
- cid (optional) - The id of a category to search. If specified, only matching articles posted to the category will be returned.
- cp (optional) - Specifies whether to search in child categories or not. If specified, articles posted to the category (cid) and in all child will be returned.
- min_date (optional) - Minimum updated date. Articles with an updated date greater than or equal to this value will be returned.The date can be in the form of a unix timestamp or mysql datetime.
- max_date (optional) - Maximum updated date. Articles with an updated date less than or equal to this value will be returned.The date can be in the form of a unix timestamp or mysql datetime.
- pv (optional) - Date mode. If specified date posted will be used instead of date updated for above 2 parameters, min_date and max_date
- limit (optional) - Number of articles to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 100.
- page (optional) - The page number of results to return. If this argument is omitted, it defaults to 1.
Search Files
GET api.php?call=files&method=search
Arguments:
- q (optional) - A free text search. A UTF-8, URL-encoded search query of 1,000 characters maximum, including operators.
- in (optional) - Search mode. Specifies how to search, If this argument is omitted, it defaults to article.
Valid values include:
- fileall (search in title, filename, file text, meta keywords(tags), description).
- file_title (search in file title only).
- filename (search in file name only).
- file_keyword (by tags). Use a comma-delimited list of tags for q argument.
- file_id (by file id). Use a comma-delimited list of file id for q argument.
- file_author_id (by author id). Use a comma-delimited list of file id for q argument.
- cid (optional) - The id of a category to search. If specified, only matching articles posted to the category will be returned.
- cp (optional) - Specifies whether to search in child categories or not. If specified, articles posted to the category (cid) and in all child will be returned.
- min_date (optional) - Minimum updated date. Files with an updated date greater than or equal to this value will be returned.The date can be in the form of a unix timestamp or mysql datetime.
- max_date (optional) - Maximum updated date. Files with an updated date less than or equal to this value will be returned.The date can be in the form of a unix timestamp or mysql datetime.
- pv (optional) - Date mode. If specified date posted will be used instead of date updated for above 2 parameters, min_date and max_date
- limit (optional) - Number of articles to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 100.
- page (optional) - The page number of results to return. If this argument is omitted, it defaults to 1.
Search News
GET api.php?call=news&method=search
Arguments:
- q (optional) - A UTF-8, URL-encoded search query of 1,000 characters maximum, including operators. Queries may additionally be limited by complexity.
- min_date (optional) - Minimum posted date. News with an posted date greater than or equal to this value will be returned. The date can be in the form of a unix timestamp or mysql datetime.
- max_date (optional) - Maximum posted date. News with an posted date less than or equal to this value will be returned. The date can be in the form of a unix timestamp or mysql datetime.
- limit (optional) - Number of news entries to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 100.
- page (optional) - The page number of results to return. If this argument is omitted, it defaults to 1.
