Get analytics engagement data

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

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

Show child attributes

activeWeeklyDays. nDays · integer · required

Number of active days per week

activeWeeklyDays. nUserWeeks · integer · required

Number of user-weeks with this activity level

activeWeeklyDays. pctUserWeeks · number<float> · required

Percentage of user-weeks with this activity level

retention · object · required

Show child attributes

retention. allUsers · object[] · required

Show child attributes

retention.allUsers. cohortWeek · string<date> · required

Week beginning date for this cohort

retention.allUsers. returningWeek · string<date> · required

Week beginning date for returning week

retention.allUsers. retentionPct · number<float> | null

Retention percentage for this cohort

retention. newUsers · object[] · required

Show child attributes

retention.newUsers. cohortWeek · string<date> · required

Week beginning date for this cohort

retention.newUsers. returningWeek · string<date> · required

Week beginning date for returning week

retention.newUsers. retentionPct · number<float> | null

Retention percentage for this cohort

sessionsHeatmap · object[] · required

Show child attributes

sessionsHeatmap. hourBucket · integer · required

Hour of day (0-23)

Required range: 0 <= x <= 23

sessionsHeatmap. weekday · integer · required

Day of week (0-6, with 0 being Sunday)

Required range: 0 <= x <= 6

sessionsHeatmap. nSessionsVisits · integer · required

Number of sessions/visits in this time period