Skip to main content

StepExecutionResult

numberOfAreaToImprovesinteger

Number of areas to improve

Example: 3
scorestringnullable

Step score

Example: 7/10
ratingstringnullable

Step rating

Example: Good
scoreInPercentagestringnullable

Score in percentage

Example: 70%
createdAtstring<date-time>nullable

Creation timestamp

Example: 2024-09-30T10:36:56.057000+00:00
sections object[]

Section hierarchy. Get Assessment with include_step_questions=true also includes answer-referenced questionnaire sections that are absent from the scored report summary; their score fields are null. Questions are not embedded in sections.

  • Array [
  • idstring

    Section unique identifier

    namestring

    Section name

    levelinteger

    Zero-based section depth

    parentIdstringnullable

    Parent section identifier; null for a root section

    pathstring[]

    Ordered section ancestry identifiers used to reconstruct the hierarchy

    scorenumbernullable

    Section score

    maxScorenumbernullable

    Section maximum score

    ratingstringnullable

    Section rating name

    customFieldsobjectnullable

    Custom fields grouped for this section

  • ]
  • StepExecutionResult
    {
    "numberOfAreaToImproves": 3,
    "score": "7/10",
    "rating": "Good",
    "scoreInPercentage": "70%",
    "createdAt": "2024-09-30T10:36:56.057000+00:00",
    "sections": [
    {
    "id": "string",
    "name": "string",
    "level": 0,
    "parentId": "string",
    "path": [
    "string"
    ],
    "score": 0,
    "maxScore": 0,
    "rating": "string",
    "customFields": {}
    }
    ]
    }