Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Assessment Score Profiles

Get Assessment Score Profiles

Use this API to retrieve comprehensive score profile information for an assessment, including:

  • Overall profile scores
  • Question-level score breakdown
  • Section and question names
  • Selected options with individual scores
  • Question weights and scoring types

Things to Know

  • This API returns data only for assessments that have been submitted and have calculated score profiles.

  • Score profiles must be configured in the assessment template.

  • The response includes detailed breakdown of how each question contributed to the overall profile score.

  • Returns an empty list if no score profiles are configured or no scores have been calculated.

  • Each question score includes the selected options and their individual contribution to the score.

  • Question weights show how much each question contributes to the overall profile score.

get/api/assessment/v2/assessments/{assessmentId}/score-profiles

Path parameters

assessmentIdstring uuid required

The unique ID of the assessment for which to retrieve score profiles.

Response

Successfully retrieved score profiles with question breakdown

assessmentIdstring uuid

Unique identifier of the assessment

profileIdstring uuid

Unique identifier of the score profile

scoreProfileRootVersionIdstring uuid

Unique identifier of the score profile (root version ID)

profileNamestring

Name of the score profile

profileScoringType'SUM' | 'AVERAGE' | 'MIN' | 'MAX' | 'WEIGHTED_AVERAGE'

Type of scoring applied to this profile

profileSequenceinteger

Sequence order of this profile in the assessment

profileScorenumber

Overall calculated score for this profile

Example response

{
  "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
  "profileId": "223e4567-e89b-12d3-a456-426614174001",
  "scoreProfileRootVersionId": "223e4567-e89b-12d3-a456-426614174001",
  "profileName": "Privacy Risk Assessment",
  "profileScoringType": "WEIGHTED",
  "profileSequence": 1,
  "profileScore": 85.5,
  "questionScores": [
    {
      "questionId": "123e4567-e89b-12d3-a456-426614174000",
      "sectionId": "223e4567-e89b-12d3-a456-426614174001",
      "questionName": "What is your data retention period?",
      "sectionName": "Data Management",
      "questionWeight": 2.5,
      "questionScoringType": "WEIGHTED",
      "selectedOptions": [
        {
          "optionText": "More than 5 years",
          "optionScore": 25
        }
      ],
      "questionScore": 75.5
    }
  ]
}