project

GET /api/v1/project/projects/{id}/progress/

Get current progress of all project sessions / clusterings

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/project/projects/:id/progress/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

A unique integer value identifying this project.

Response

project_has_completed_sessionsboolean required

user_uncompleted_session_progressobject nullable required

other_uncompleted_session_progressobject nullable required

clusteringstring

require_clusteringboolean

Example response

{
  "project_has_completed_sessions": true,
  "other_uncompleted_session_progress": "{}",
  "clustering": "clustering",
  "user_uncompleted_session_progress": "{}",
  "require_clustering": true
}

Changes

No recorded changes to this operation across all 5 revisions of this API.