REreadme
Search

Get data by search term

Changed on

Retrieve a breakdown of users who have searched for a particular term, include email and count.

get/v2/search/{searchTerm}

Request

  • Base URL
    https://metrics.readme.io
  • URL
    https://metrics.readme.io/v2/search/{searchTerm}
  • Auth
    HTTP basic

Path parameters

searchTermstring required

Search term

Query parameters

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

Search term breakdown per unique user.

breakdownobject

Changes