Skip to main content
GET
Get retention data

Query Parameters

projectId
string
required

Project ID to get retention data for

Example:

"550e8400-e29b-41d4-a716-446655440000"

cohortType
enum<string>
default:WEEKLY

Cohort type for grouping

Available options:
WEEKLY,
MONTHLY,
CUSTOM

Response

200 - application/json

Retention data with cohort breakdown

cohortType
enum<string>
required

Type of cohort grouping

Available options:
WEEKLY,
MONTHLY,
CUSTOM
cohorts
object[]
required
averages
object
required