Sign in

v1

latestOpenAPI 3.0.02026-07-26135449.7 KB

get/v1/search/statistics

Query parameters

qstring

The query string to search for content. This parameter is multi-lingual. If omitted or empty/whitespace-only, the API uses a broad default query.

offsetinteger

The number of items will be skipped before the first result. The default value for offset is 0. This is useful for pagination. Could be used in combination with size.

sizeinteger

The max. value depends on which API Package you are using. The default value for size is 10. See API-Packages for more information.

An alias for size is limit

date_fromstring date-time

The maximum search depth is limited to 20 years from today while the default is 3 months from today. Supported formats are

  • RFC 33939 (%Y-%m-%dT%H:%M:%S like in ISO 8601)
  • %Y-%m-%d %H:%M:%S - example 2024-03-07 12:45:38
  • %d.%m.%Y %H:%M:%S - example 03.07.2024 12:45:38
  • %Y/%m/%d %H:%M:%S - example 2024/03/07 12:45:38
  • %Y-%m-%d - example 2024-03-07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %d.%m.%Y - example 03.07.2024 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %Y/%m/%d - example 2024/03/07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)

The start date to search for content.

date_tostring date-time

Supported formats are

  • RFC 33939 (%Y-%m-%dT%H:%M:%S like in ISO 8601)
  • %Y-%m-%d %H:%M:%S - example 2024-03-07 12:45:38
  • %d.%m.%Y %H:%M:%S - example 03.07.2024 12:45:38
  • %Y/%m/%d %H:%M:%S - example 2024/03/07 12:45:38
  • %Y-%m-%d - example 2024-03-07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %d.%m.%Y - example 03.07.2024 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %Y/%m/%d - example 2024/03/07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)

The end date to search for content. If not set, the current date is used.

premiumboolean nullable

Filters content based on its premium status. If set to true, only premium content is returned. If set to false, only free content is returned. If not set, both free and premium content is returned.

Response

The request has succeeded.

total_countinteger required

The total number of available items matching the request.

total_pagesinteger

The total number of pages available, based on the selected size parameter