List Role Evaluation Results

Get campaign results

curl --request GET \
  --url http://localhost:3000/dev/v1/campaigns/role/results \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "recommendation_status": "<string>",
      "overall_score": 123,
      "additional_scores": {
        "cefr": {
          "score": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "order_index": "<string>"
    }
  ],
  "has_more": true,
  "last_record_index": "<string>"
}

GET

campaigns

role

results

Get campaign results

curl --request GET \
  --url http://localhost:3000/dev/v1/campaigns/role/results \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "recommendation_status": "<string>",
      "overall_score": 123,
      "additional_scores": {
        "cefr": {
          "score": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "order_index": "<string>"
    }
  ],
  "has_more": true,
  "last_record_index": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

campaign_id

string<uuid>

required

Unique identifier for the campaign

limit

integer

default:10

Number of results to return

Required range: 1 <= x <= 100

sort

enum<string>

default:desc

Sort order for the results

Available options:

desc,

asc

start_date

string<date>

Start date for filtering results (YYYY-MM-DD format)

end_date

string<date>

End date for filtering results (YYYY-MM-DD format)

starting_after

integer<int64>

Pagination cursor - results after this big integer value

report_type

enum<string>

default:OVERALL

Type of report to generate

Available options:

DETAILED,

OVERALL

Response

Campaign results response

Option 1
Option 2

Response for OVERALL report type

data

object[]

Array of campaign result records

Show child attributes

data.id

string<uuid>

Unique identifier for the result record

data.campaign_id

string<uuid>

Unique identifier of the campaign this result belongs to

data.user_id

string<uuid>

Unique identifier of the user who generated this result

data.email

string<email>

Email address of the user

data.recommendation_status

string

Recommendation status for the user (e.g., NOT_RECOMMENDED, RECOMMENDED, STRONGLY_RECOMMENDED)

data.overall_score

number<float>

Overall score representing the user's demonstrated proficiency level

data.additional_scores

object

Additional scoring metrics and assessments

Show child attributes

data.additional_scores.cefr

object

CEFR (Common European Framework of Reference for Languages) assessment

Show child attributes

data.additional_scores.cefr.score

string

CEFR level (e.g., A1, A2, B1, B2, C1, C2)

data.created_at

string<date-time>

Timestamp when the result record was created

data.updated_at

string<date-time>

Timestamp when the result record was last updated

data.order_index

string

Order index used for sorting and pagination

has_more

boolean

Indicates whether there are more results available for pagination

last_record_index

string

The order index of the last record in the current page, used for pagination

List List Session Evaluation Results

⌘I

Overview

API Reference

List Role Evaluation Results

Authorizations

Query Parameters

Response