Get analytics engagement data

Returns the analytics engagement data for the specified environment.

GET /environments/{environmentId}/analytics/engagement

Get analytics engagement data

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement \
  --header 'Authorization: Bearer <token>'

200

{
  "activeWeeklyDays": [
    {
      "nDays": 123,
      "nUserWeeks": 123,
      "pctUserWeeks": 123
    }
  ],
  "retention": {
    "allUsers": [
      {
        "cohortWeek": "2023-12-25",
        "returningWeek": "2023-12-25",
        "retentionPct": 123
      }
    ],
    "newUsers": [
      {
        "cohortWeek": "2023-12-25",
        "returningWeek": "2023-12-25",
        "retentionPct": 123
      }
    ]
  },
  "sessionsHeatmap": [
    {
      "hourBucket": 11,
      "weekday": 3,
      "nSessionsVisits": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

start · string · required

Start date in ISO format (YYYY-MM-DD)

end · string · required

End date in ISO format (YYYY-MM-DD)

Response

200

application/json

Analytics engagement data

activeWeeklyDays · object[] · required

Distribution of how many days per week users are active

Show child attributes

retention · object · required

Weekly cohort retention data for all users and new users

Show child attributes

sessionsHeatmap · object[] · required

Session activity heatmap grouped by hour of day and day of week

Show child attributes