---
title: "Get Retention"
method: GET
path: "/api/sites/{site}/retention"
tags: ["Insights"]
---

# Get Retention

`GET /api/sites/{site}/retention`

## Request

- Base URL: `https://app.onyxmetric.com`
- URL: `https://app.onyxmetric.com/api/sites/{site}/retention`
- Auth: one of:
  - HTTP bearer
  - API key in query parameter `api_key`
  - API key in cookie `better-auth.session_token`

Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.

## Path parameters

- `site` union, required
  - integer
  - string

## Query parameters

- `start_date` string, date
- `end_date` string, date
- `time_zone` string
- `start_datetime` string
- `end_datetime` string
- `past_minutes_start` integer
- `past_minutes_end` integer
- `filters` string
- `segment_id` integer

## Response `200`

Successful response. Refer to the linked endpoint documentation for the response fields.

- unknown

## Other responses

- `400`: Invalid request
- `401`: Authentication required
- `403`: Insufficient permission
- `404`: Resource not found
- `429`: Rate limit exceeded
- `500`: Unexpected server error

---

[API](https://skmtc.dev/onyxmetric/apis/onyxmetric-api.md) · [All operations](https://skmtc.dev/onyxmetric/apis/onyxmetric-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onyxmetric/apis/onyxmetric-api/revisions/c99014014805?raw)