Skip to main content
GET
/
v1
/
analytics
/
retention
/
cohorts
Get retention cohorts
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/retention/cohorts \
  --header 'x-api-key: <api-key>'
{
  "meta": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "data": [
    {
      "cohort_date": "2023-12-25",
      "period": 123,
      "cohort_size": 1,
      "retained_users": 1,
      "retention_rate": 123
    }
  ],
  "rows": 123,
  "statistics": {
    "elapsed": 123,
    "rows_read": 123,
    "bytes_read": 123
  }
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

​
collection_id
string<uuid>

Filter by collection ID.

​
collection_slug
string

Filter by collection slug.

​
date_from
string<date>
required

Start date in ISO 8601 format (required).

​
date_to
string<date>

End date in ISO 8601 format.

​
aggregation
enum<string>

Cohort period granularity.

Available options:
daily,
weekly,
monthly
​
periods
integer

Number of retention periods to calculate (1-12).

Required range: 1 <= x <= 12

Response

Successfully retrieved retention cohort data.

Tinybird response envelope for retention/cohorts.

​
meta
object[]
required
​
data
object[]
required
​
rows
integer
required
​
statistics
object
required

Query execution statistics returned in every Tinybird API response.