---
title: "List searches"
method: GET
path: "/v2/search/list"
tags: ["Search"]
---

# List searches

`GET /v2/search/list`

## Request

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

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.

## Query parameters

- `searchTerm` union
  - string
  - string[]
- `email` union
  - string
  - Email[]
- `rangeLength` number: Length of the date range.
- `resolution` 'hour' | 'day' | 'week' | 'month': Relative time interval of data buckets.
- `rangeStart` string, date: Starting date
- `rangeEnd` string, date: Ending date
- `limit` number
- `page` number
- `pageSize` number

## Headers

- `x-timezone` string: Locale timezone in IANA format.

## Response `200`

Individual searches and the result each one led to.

- object
  - `searches` object[]
    - `searchTerm` string: Term the reader searched for.
    - `link` string, nullable: Path of the result the reader clicked, or `null` when the reader left the search without choosing a result.
    - `email` string, email, nullable
    - `createdAt` string, date-time

## Changes

- **2026-11-03** `4e37e64df55a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/readme/apis/developer-metrics-api/changes/v2/search/list/get.md)

---

[API](https://skmtc.dev/readme/apis/developer-metrics-api.md) - [All operations](https://skmtc.dev/readme/apis/developer-metrics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/readme/apis/developer-metrics-api/revisions/4e37e64df55a?raw)