Tracking

Tracking objects store learner progress. Using the API, you can fetch tracking objects for your courses and learners.

Get trackings Embed Core and above

Use this endpoint to get tracking objects.

GET/v1/headless/trackings

Query parameters

Field	Type	Required	Default	Options
`id`	`number`	Yes	—	—
`identifier`	`string`	No	—	—
`clientIdentifier`	`string`	No	—	—
`start`	`string`	No	—	—
`end`	`string`	No	—	—
`length`	`number`	No	`100`	—
`page`	`number`	No	`0`	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/trackings?id=1234&identifier=user_123&clientIdentifier=client_123&start=example&end=example&length=100&page=0" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

[
  {
    "id": 1234,
    "commenced": "2026-06-06T18:42:30.118Z",
    "completed": "2026-06-06T18:42:30.118Z",
    "feedback": "example",
    "email": "example",
    "identifier": "user_123",
    "passed": false,
    "progress_percent": 65,
    "total_time": 3600,
    "language": "en",
    "scorm": false
  }
]

Get collection trackings Embed Core and above

Use this endpoint to get tracking objects for collection learners.

GET/v1/headless/collection/trackings

Query parameters

Field	Type	Required	Default	Options
`id`	`number`	Yes	—	—
`start`	`string`	No	—	—
`end`	`string`	No	—	—
`length`	`number`	No	`100`	—
`page`	`number`	No	`0`	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/collection/trackings?id=1234&start=example&end=example&length=100&page=0" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

[
  {
    "id": 1234,
    "identifier": "user_123",
    "name": "example",
    "commenced": "2026-06-06T18:42:30.119Z",
    "completed": "2026-06-06T18:42:30.119Z",
    "progressPercent": 65,
    "totalTime": 3600,
    "courses": [
      {
        "id": 1234,
        "trackingId": 1234,
        "courseId": 1234,
        "courseTitle": "example",
        "sequence": 1,
        "commenced": "2026-06-06T18:42:30.119Z",
        "completed": "2026-06-06T18:42:30.119Z",
        "feedback": "example",
        "identifier": "user_123",
        "progress_percent": 65,
        "totalTime": 3600
      }
    ]
  }
]

Get screen trackings Embed Core and above

Use this endpoint to get tracking objects for screen learners.

GET/v1/headless/screen/trackings

Query parameters

Field	Type	Required	Default	Options
`id`	`number`	Yes	—	—
`identifier`	`string`	No	—	—
`clientIdentifier`	`string`	No	—	—
`start`	`string`	No	—	—
`end`	`string`	No	—	—
`length`	`number`	No	`100`	—
`page`	`number`	No	`0`	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/screen/trackings?id=1234&identifier=user_123&clientIdentifier=client_123&start=example&end=example&length=100&page=0" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

[
  {
    "id": 1234,
    "identifier": "user_123",
    "clientIdentifier": "client_123",
    "name": "example",
    "avatar": "example",
    "language": "en",
    "commenced": "2026-06-06T18:42:30.119Z",
    "completed": "2026-06-06T18:42:30.119Z",
    "progressPercent": 65,
    "attempts": []
  }
]

Get user trackings Embed Core and above

Use this endpoint to get tracking objects grouped by user.

GET/v1/headless/user/trackings

Query parameters

Field	Type	Required	Default	Options
`identifier`	`string`	Yes	—	—
`clientIdentifier`	`string`	No	—	—
`start`	`string`	No	—	—
`end`	`string`	No	—	—
`length`	`number`	No	`100`	—
`page`	`number`	No	`0`	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/user/trackings?identifier=user_123&clientIdentifier=client_123&start=example&end=example&length=100&page=0" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

{
  "identifier": "user_123",
  "clientIdentifier": "client_123",
  "name": "example",
  "avatar": "example",
  "totals": {
    "viewed": 12,
    "completed": 12,
    "averageProgress": 65
  },
  "trackings": [
    {
      "id": 1234,
      "identifier": "user_123",
      "clientIdentifier": "client_123",
      "language": "en",
      "commenced": "2026-06-06T18:42:30.119Z",
      "completed": "2026-06-06T18:42:30.119Z",
      "progressPercent": 65,
      "attempts": []
    }
  ]
}

Get tracking Embed Core and above

Use this endpoint to get a specific tracking object by ID.

GET/v1/headless/tracking/{id}

Path parameters

Field	Description	Options
`id`	Tracking ID	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/tracking/1234" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Get collection tracking Embed Core and above

Use this endpoint to get a specific collection tracking object by ID.

GET/v1/headless/collection/tracking/{id}

Path parameters

Field	Description	Options
`id`	Collection tracking ID	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/collection/tracking/1234" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Delete tracking Embed Automate and above

Use this endpoint to delete a tracking object by course ID and identifier.

DELETE/v1/headless/tracking

Body parameters

Field	Type	Required	Desc	Options
`id`	`number`	Yes	Course ID	—
`identifier`	`string`	Yes	Learner identifier whose tracking against this course should be deleted	—

Examples

cURL request

curl --request DELETE \
  --url "https://api.coassemble.com/api/v1/headless/tracking" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "id": 1234,
    "identifier": "user_123"
}'

Response

JSON response

false