Skip to main content
GET
/
retention
Get Retention Analysis
curl --request GET \
  --url https://ebn.telemetree.io/public-api/retention \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "cohorts": {},
      "retentionMatrix": [
        [
          "<string>"
        ]
      ],
      "combinedRetention": [
        123
      ],
      "totalUsers": 123,
      "groupBy": "<string>",
      "groups": [
        {}
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your API Key (Dashboard->Settings)

Query Parameters

group_by
string | null
start
string
required

Start date in YYYYMMDD format

end
string
required

End date in YYYYMMDD format

filters
string | null

Response

Successful Response

data
RetentionDataMain · object[]
required

The retention data