Product Analytics

Compute a retention grid

Compute a retention grid, showing how much of each cohort came back over each subsequent period. Rows are cohorts, columns are return periods, and each cell holds the count and rate of entities that returned.

post/api/v2/product-analytics/retention/grid

Request

Request body

Response

OK

Example response

{
  "data": {
    "attributes": {
      "cohorts": [
        {
          "cells": [
            {
              "type": "raw"
            }
          ],
          "type": "raw",
          "unit": [
            {
              "family": "time",
              "name": "nanosecond"
            }
          ]
        }
      ],
      "retention_periods": [
        {
          "unit": "week",
          "value": 1
        }
      ],
      "unit": [
        {
          "family": "time",
          "name": "nanosecond"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "retention_grid_response"
  }
}

Changes

Changes to this operation have not been checked yet.