Get analytics engagement data

GET

environments

{environmentId}

analytics

engagement

Get analytics engagement data

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

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Internal Server Error"
}

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

Analytics engagement data

activeWeeklyDays

object[]

required

Show child attributes

retention

object

required

Show child attributes

sessionsHeatmap

object[]

required

Show child attributes

Last modified on January 21, 2026

Get analytics wallets breakdown dataReturns the wallets breakdown analytics data for the specified environment.

⌘I

Get analytics engagement data

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

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/analytics/engagement")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Internal Server Error"
}

Overview

Endpoints

Schemas

Get analytics engagement data

Authorizations

Path Parameters

Query Parameters

Response