Retention

Get Retention For Project

GET
/v0/projects/{idOrSlug}/retention

Authorization

apiKeyAuth
headerx-api-key<token>

FastStats API key. Pass it in the x-api-key header or as a Bearer token in the Authorization header.

Path Parameters

idOrSlug*string

Query Parameters

granularity?string
Value in"day""week""month"
cohortType?string
Value in"first""recurring"
returnType?string
Value in"exact""on_or_after"
cohortFrom*string
cohortTo*string
periodCount?string
includeHasMore?string
source*string
Value in"web""mods"
startEvent?string
Length1 <= length <= 200
returnEvent?string
Length1 <= length <= 200
timezone?string
filterFields?string|array<string>
filterOperators?|array<>
filterValues?string|array<string>
segment?string|array<string>
excludeSegment?string|array<string>

Response Body

RetentionCohortPage

application/json
  1. response
cohorts*array<>
hasMore*boolean
Example Request
curl -X GET 'https://api.faststats.dev/v0/projects/string/retention?cohortFrom=string&cohortTo=string&source=web'
Example Response
{  "cohorts": [    {      "cohort": "string",      "cohortDate": "string",      "users": 0,      "periods": [        {          "period": 0,          "usersRetained": 0,          "retentionRate": 0        }      ]    }  ],  "hasMore": true}