Domoscio Viz Engine (v2.2.0)

We designed the Domoscio Visualization Engine in a Restful way, so that your user experience is simple and straightforward.

You will find in this documentation all the information necessary to interact with it.

Authentication

The workflow to authentify is based on Oauth2 protocol. To have access to Domoscio functionalities the user should follow these steps:

AuthorizationToken:

The AuthorizationToken is given to the user when he starts working with the Domoscio API. This token must remain secret.
1. The AuthorizationToken should be used inside the Header of the request when calling the API for the first time & when the RefreshToken expires:
  Authorization: Bearer < AuthorizationToken >
2. Inside the response Header, the AccessToken and RefreshToken will be given:
  AccessToken: < AccessToken >
  RefreshToken: < RefreshToken >
3. The RefreshToken should now be used in the header of the API request with the AccessToken. Here is an example on how to retrieve the AccessToken & RefreshToken:
Note: You will receive the AccessToken in the response at every request. However, when the RefreshToken is expired, you will receive a 401 error. At this point, it will be necessary to reuse the AuthenticationToken to retrieve a new pair of RefreshToken / AccessToken.

Header Parameters

When making the requests to the Visualization Engine, you will need to specify the following parameters in the header:

ClientId: The client ID given to you by Domoscio.
Authorization: The AuthorizationToken when calling the engine for the first time.
RefreshToken & AccessToken: The tokens retrieved after the first call.
User-Agent: The agent from which you are making the requests.

Request Process

MemorizeClassRoomDatatable

The MemorizeClassRoomDatatable shows for each student whether they are up to date with their reviews. The table is represented in the image below:

MemorizeClassRoomDatatable

In order to obtain the MemorizeClassRoomDatatable iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/memorize_class_room_datatable?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

StudentsDatatableMemorize

The StudentsDatatableMemorize summarizes for each student, their activities, the average time spent on each session, their success rates, and their knowledge retention levels. The table is represented in the image below:

StudentsDatatableMemorize

In order to obtain the StudentsDatatableMemorize iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/students_datatable_memorize?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

EventHistory

The EventHistory graph summarizes the number of events that happend since a specific date for each month. The graph is represented in the image below:

EventHistory

In order to obtain the EventHistory iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
	string or boolean (Event_type) Enum: "EventRead" "EventReview" "EventResult" false The type of event for which you wish to get a graph/datatable, set to false if you don't wish to specify.
date_start required	string <date> (Date_start) The date from which you wish to display the events.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"date_start": "2020-03-25",
"event_type": "EventReview",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/event_history?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

AverageMemorization

The AverageMemorization summarizes for each subtopic the level of knowledge retention for a specific student or the average for a set of students. The visualization is represented in the image below:

AverageMemorization

In order to obtain the AverageMemorization iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
	string or boolean (Event_type) Enum: "EventRead" "EventReview" "EventResult" false The type of event for which you wish to get a graph/datatable, set to false if you don't wish to specify.
date_start	string <date> (Date_start) The date from which you wish to display the events.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"event_type": "EventReview",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/average_memorization?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

MemorizeProgression

The MemorizeProgression summarizes for each subtopic the level of knowledge retention for a specific student. The visualization is represented in the image below:

MemorizeProgression

In order to obtain the MemorizeProgression iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
tour_guide	boolean (Tour_guide) Triggers the onboarding guide

Responses

Request samples

Payload

Content type

application/json

{"student_uid": "student_1",
"locale": "en"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/memorize_progression?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

DatatableLockEngagement

The LockEngagement datatable shows the students' engagement for a defined time period. The datatable is represented in the image below:

DatatableLockEngagement

In order to obtain the DatatableLockEngagement iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
student_group_uid required	Array of strings (Student_group_uid) An array of Student groups for which you wish to fetch data.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
start_date required	string <date> (Start_date) The date after which you want to display data.
end_date required	string <date> (End_date) The date before which you want to display data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"learning_program_uid": "learning_program_1",
"student_uid": ["student_1",
"student_2"
],
"start_date": "2022-01-01",
"end_date": "2023-01-01",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/datatable_lock_engagement?datastore_id=15652&token_tmp=vWtzbbqeZV4TqMks5qxncASy"
}
]

DatatableLockProgression

The LockProgression datatable shows the students' progression for a defined time period. The datatable is represented in the image below:

DatatableLockProgression

In order to obtain the DatatableLockProgression iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
student_group_uid required	Array of strings (Student_group_uid) An array of Student groups for which you wish to fetch data.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
start_date required	string <date> (Start_date) The date after which you want to display data.
end_date required	string <date> (End_date) The date before which you want to display data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"learning_program_uid": "learning_program_1",
"student_uid": ["student_1",
"student_2"
],
"start_date": "2022-01-01",
"end_date": "2023-01-01",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/datatable_lock_progression?datastore_id=15652&token_tmp=vWtzbbqeZV4TqMks5qxncASy"
}
]

DatatableLockUsage

The LockUsage datatable shows the students' usage for a defined time period. The datatable is represented in the image below:

DatatableLockUsage

In order to obtain the DatatableLockUsage iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
student_group_uid required	Array of strings (Student_group_uid) An array of Student groups for which you wish to fetch data.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
start_date required	string <date> (Start_date) The date after which you want to display data.
end_date required	string <date> (End_date) The date before which you want to display data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"learning_program_uid": "learning_program_1",
"student_uid": ["student_1",
"student_2"
],
"start_date": "2022-01-01",
"end_date": "2023-01-01",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/datatable_lock_usage?datastore_id=15652&token_tmp=vWtzbbqeZV4TqMks5qxncASy"
}
]

AdaptiveClassRoomDatatable

The AdaptiveClassRoomDatatable shows for each student whether they did their positioning, followed the recommendations or perfomed all the actions. The table is represented in the image below:

AdaptiveClassRoomDatatable

In order to obtain the AdaptiveClassRoomDatatable iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/adaptive_class_room_datatable?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

StudentsDatatableAdaptive

The StudentsDatatableAdaptive summarizes for each student, their activities, the average time spent, the percentage of their mastered skills, and the number of recommendations they clicked. The table is represented in the image below:

StudentsDatatableAdaptive

In order to obtain the StudentsDatatableAdaptive iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/students_datatable_adaptive?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

EventHistory

The EventHistory graph summarizes the number of events that happend since a specific date for each month. The graph is represented in the image below:

EventHistory

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
	string or boolean (Event_type) Enum: "EventRead" "EventReview" "EventResult" false The type of event for which you wish to get a graph/datatable, set to false if you don't wish to specify.
date_start required	string <date> (Date_start) The date from which you wish to display the events.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"date_start": "2020-03-25",
"event_type": "EventReview",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/event_history?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

AverageMastery

The AverageMastery graph shows the average mastery levels of the learners on the different skills of the theme. The graph is represented in the image below:

AverageMastery Deprecated

In order to obtain the AverageMastery iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	integer or Array of integers (Student_id) Scope the statistics with specific Student ID(s). Required if no student_uid is given.
required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	integer or Array of integers (Objective_id) Scope the statistics with specific Objective ID(s). Required if no objective_uid is given.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
student_ids	Array of integers (Student_ids) Deprecated An array of Student IDs for which you wish to fetch data.
objective_ids	Array of integers (Objective_ids) Deprecated An array of Objective IDs for which you wish to fetch data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"objective_uid": ["objective_1"
],
"student_uid": ["student_1",
"student_2"
],
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/average_mastery?datastore_id=5&token_tmp=e3KiF3jntmaZeXGKtjXR9B1G"
}
]

MasteryProgression

The MasteryProgression graph shows the average mastery levels of the learners on the different skills of the theme. The graph is represented in the image below:

MasteryProgression

In order to obtain the MasteryProgression iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
student_group_uid required	Array of strings (Student_group_uid) An array of Student groups for which you wish to fetch data.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"learning_program_uid": "learning_program_1",
"student_uid": ["student_1",
"student_2"
],
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/mastery_progression?datastore_id=168&token_tmp=Le5298QxxJDjkq4RM8zJXPm2"
}
]

DatatableHubEngagement

The HubEngagement datatable shows the students' engagement for a defined time period. The datatable is represented in the image below:

DatatableHubEngagement

In order to obtain the DatatableHubEngagement iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
student_group_uid required	Array of strings (Student_group_uid) An array of Student groups for which you wish to fetch data.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
start_date required	string <date> (Start_date) The date after which you want to display data.
end_date required	string <date> (End_date) The date before which you want to display data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"learning_program_uid": "learning_program_1",
"student_uid": ["student_1",
"student_2"
],
"start_date": "2022-01-01",
"end_date": "2023-01-01",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/datatable_hub_engagement?datastore_id=15652&token_tmp=vWtzbbqeZV4TqMks5qxncASy"
}
]

DatatableHubProgression

The HubProgression datatable shows the students' progression for a defined time period. The datatable is represented in the image below:

DatatableHubProgression

In order to obtain the DatatableHubProgression iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
student_group_uid required	Array of strings (Student_group_uid) An array of Student groups for which you wish to fetch data.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
start_date required	string <date> (Start_date) The date after which you want to display data.
end_date required	string <date> (End_date) The date before which you want to display data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"learning_program_uid": "learning_program_1",
"student_uid": ["student_1",
"student_2"
],
"start_date": "2022-01-01",
"end_date": "2023-01-01",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/datatable_hub_progression?datastore_id=15652&token_tmp=vWtzbbqeZV4TqMks5qxncASy"
}
]

DatatableHubUsage

The HubUsage datatable shows the students' usage for a defined time period. The datatable is represented in the image below:

DatatableHubUsage

In order to obtain the DatatableHubUsage iframe, you will need to make a POST request with specific parameters as shown below. You will then receive the iframe URL that you will need to fetch with a GET request.

header Parameters

ClientId required	integer Example: 5 The client ID given to you by Domoscio.
Authorization required	string Example: Token token=given_token The AuthorizationToken when calling the engine for the first time.
AccessToken required	string The AccessToken received after the first call, it is required with the RefreshToken if the AuthorizationToken is not given in the header.
RefreshToken required	string The RefreshToken received after the first call, it is required with the AccessToken if the AuthorizationToken is not given in the header.
User-Agent required	string Example: PostmanRuntime/7.26.8 The agent from which you are making the requests.

Request Body schema: application/json

required	string or Array of strings (Student_uid) Scope the statistics with a set of Student UID(s). Required if no student_id is given.
student_group_uid required	Array of strings (Student_group_uid) An array of Student groups for which you wish to fetch data.
learning_program_uid required	string (Learning_program_uid) Scope the statistics with a LearningProgram UID.
required	string or Array of strings (Objective_uid) Scope the statistics with a set of Objective UID(s). Required if no objective_id is given.
start_date required	string <date> (Start_date) The date after which you want to display data.
end_date required	string <date> (End_date) The date before which you want to display data.
locale	string (Locale) Enum: "fr" "en" "es" The language in which the tables and graphs labels should be displayed.
primary_color	string (Primary_color) The primary color for the graph/table, you should use the hexcolor format without the '#' sign.
secondary_color	string (Secondary_color) The secondary color for the graph/table, you should use the hexcolor format without the '#' sign.

Responses

Request samples

Payload

Content type

application/json

{"learning_program_uid": "learning_program_1",
"student_uid": ["student_1",
"student_2"
],
"start_date": "2022-01-01",
"end_date": "2023-01-01",
"locale": "en",
"primary_color": "04accc",
"secondary_color": "113240"
}

Response samples

Content type

application/json

[{"success": true,
"url": "https://visualization-engine.domoscio.com/datatable_hub_usage?datastore_id=15652&token_tmp=vWtzbbqeZV4TqMks5qxncASy"
}
]