Get user detailed analytics data

POST

public

get-user-detailed-analytics-data

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-user-detailed-analytics-data \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "userId": "<string>",
        "userEmail": "[email protected]",
        "fermionUserId": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "details": {
          "personalData": {
            "userId": "<string>",
            "fermionUserId": "<string>",
            "email": "[email protected]",
            "createdAtIso": "2023-11-07T05:31:56Z",
            "lastSeenAtIso": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "profilePicUrl": "<string>"
          },
          "productEnrollmentsData": [
            {
              "productId": "<string>",
              "productName": "<string>",
              "productSlug": "<string>",
              "enrolledAtIso": "2023-11-07T05:31:56Z",
              "productType": "FermionCourse",
              "completionPercentageOutOf100": 50,
              "certificateClaimedAtIso": "2023-11-07T05:31:56Z"
            }
          ],
          "activityData": [
            {
              "dateIso": "2023-11-07T05:31:56Z",
              "minutesSpent": 1,
              "xpEarned": 123
            }
          ]
        }
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.userId

string

Internal userId you have been using for the user in your database

data.data.userEmail

string<email>

Email of the user

data.data.fermionUserId

string

Fermion provided user ID of the user.

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.details

object

required

Show child attributes

output.data.details.personalData

object

required

Show child attributes

output.data.details.personalData.userId

required

Internal userId you have been using for the user in your database. Null if not present

output.data.details.personalData.fermionUserId

string

required

Fermion provided user ID of the user.

output.data.details.personalData.email

required

Email address of the user

output.data.details.personalData.createdAtIso

string<date-time>

required

Timestamp when the user was created

output.data.details.personalData.lastSeenAtIso

required

Timestamp when the user was last seen using the platform

output.data.details.personalData.name

string

required

Name of the user

Required string length: 2 - 100

output.data.details.personalData.profilePicUrl

string<uri>

required

URL of the user's profile picture

output.data.details.productEnrollmentsData

object[]

required

List of products the user is enrolled in

Option 1
Option 2
Option 3

Show child attributes

output.data.details.productEnrollmentsData.productId

string

required

Unique identifier of the product

Minimum string length: 1

output.data.details.productEnrollmentsData.productName

string

required

Name of the product

Minimum string length: 1

output.data.details.productEnrollmentsData.productSlug

string

required

URL-friendly identifier of the product

Minimum string length: 1

output.data.details.productEnrollmentsData.enrolledAtIso

string<date-time>

required

Timestamp when the user enrolled in the product

output.data.details.productEnrollmentsData.productType

enum<string>

required

Type of product - Course

Available options:

FermionCourse

output.data.details.productEnrollmentsData.completionPercentageOutOf100

number

required

Course completion percentage (0-100)

Required range: 0 <= x <= 100

output.data.details.productEnrollmentsData.certificateClaimedAtIso

required

Timestamp when the course certificate was claimed, null if not claimed

output.data.details.activityData

object[]

required

Daily activity data including time spent and XP earned

Show child attributes

output.data.details.activityData.dateIso

string<date-time>

required

Date of the activity

output.data.details.activityData.minutesSpent

number

required

Number of minutes spent on the platform

Required range: x >= 0

output.data.details.activityData.xpEarned

number

required

XP points earned on this date

Remove fermion instructor from school Revoke an instructor's access to your school Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 10 requests in a window of 1m.

⌘I

Get user detailed analytics data

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-user-detailed-analytics-data \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "userId": "<string>",
        "userEmail": "[email protected]",
        "fermionUserId": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "details": {
          "personalData": {
            "userId": "<string>",
            "fermionUserId": "<string>",
            "email": "[email protected]",
            "createdAtIso": "2023-11-07T05:31:56Z",
            "lastSeenAtIso": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "profilePicUrl": "<string>"
          },
          "productEnrollmentsData": [
            {
              "productId": "<string>",
              "productName": "<string>",
              "productSlug": "<string>",
              "enrolledAtIso": "2023-11-07T05:31:56Z",
              "productType": "FermionCourse",
              "completionPercentageOutOf100": 50,
              "certificateClaimedAtIso": "2023-11-07T05:31:56Z"
            }
          ],
          "activityData": [
            {
              "dateIso": "2023-11-07T05:31:56Z",
              "minutesSpent": 1,
              "xpEarned": 123
            }
          ]
        }
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response