コンテンツにスキップ

Get retention cohorts

GET
/v1/projects/{id}/retention

Returns player retention cohort data showing day-1, day-7, and day-30 retention rates for each cohort date within the specified time period.

id
required
string format: uuid

Project UUID.

days
integer
default: 30
Allowed values: 7 14 30 90

Time period in days.

Array of retention cohorts.

object
success
boolean
data
Array<object>

Retention data for a single cohort (players who first appeared on cohort_date).

object
cohort_date

Date the cohort was formed (YYYY-MM-DD).

string
Example
2024-01-15
cohort_size

Number of unique players in this cohort.

integer
d1

Players who returned on day 1.

integer
d7

Players who returned on day 7.

integer
d30

Players who returned on day 30.

integer
d1_pct

Day-1 retention percentage (0-100).

number
d7_pct

Day-7 retention percentage (0-100).

number
d30_pct

Day-30 retention percentage (0-100).

number
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.

Invalid request parameters or body.

object
success
boolean
error

Human-readable error message.

string

Missing or invalid API key.

object
success
boolean
error

Human-readable error message.

string

Resource not found.

object
success
boolean
error

Human-readable error message.

string

Rate limit exceeded.

object
success
boolean
error

Human-readable error message.

string
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.