All parameters for the /cyberFilter search endpoint, with defaults.
| Parameter | Type | Default | Description |
|---|---|---|---|
token | string | - | Your API token |
q | string | "" | Boolean query - see Query Syntax |
ts | integer | 3 months ago | Start of the search window, Unix milliseconds - see Time Range |
size | integer | 10 | Posts per response, 1-10 |
sort | string | crawled | crawled, relevancy, updated, published, or thread.published |
order | string | by sort | asc or desc. Defaults to asc for crawled and updated, desc for published and thread.published |
from | integer | 0 | Offset into results, used with sorts other than crawled |
An unknown sort or order value returns 400.
| Parameter | Type | Default | Description |
|---|---|---|---|
highlight | boolean | false | Return matched fragments in highlightText and highlightTitle |
structured | boolean | - | true returns only structured posts, false only unstructured |
warning | boolean | false | Validate the query and return potential issues in the warnings array |
format | string | json | Response format: json, xml, or excel |
highlight is a presence-based flag: sending it with any value - even false - turns it on. Omit it entirely to keep the default.
Any other query parameter becomes an exact-match filter on the corresponding field (&language=english), and exclude_-prefixed parameters negate (&exclude_site.type=chat) - see Filters.
