REreadme
Search

List searches

Changed on

Retrieve each individual search in your project, newest first, including the result the reader clicked. Filter by searchTerm to see which results readers chose for a given query.

get/v2/search/list

Request

  • Base URL
    https://metrics.readme.io
  • URL
    https://metrics.readme.io/v2/search/list
  • Auth
    HTTP basic

Query parameters

string
OR
string[]

Term used in a documentation search.

string
OR
Email[]

Authenticated user's email.

rangeLengthnumber

Length of the date range.

resolution'hour' | 'day' | 'week' | 'month'

Relative time interval of data buckets.

rangeStartstring date

Starting date

Example:2021-01-01
rangeEndstring date

Ending date

Example:2021-01-01
limitnumber

Deprecated in favor of pageSize. Paginated endpoints ignore this parameter, and endpoints that still honor it treat values above 100 as 100.

pagenumber

Zero-indexed page of results to return.

pageSizenumber

Number of results per page, capped at 100. To retrieve every result, keep incrementing page until the list of results in the response is empty. /v2/pageview/{path} and /v2/thumb/{path} respond with a 404 instead of an empty list once page is past the last page.

Headers

x-timezonestring

Locale timezone in IANA format.

Response

Individual searches and the result each one led to.

Changes