# Results
Evalytics uses a couple of generic result-endpoints with which all results can be retrieved (assuming the user has permission to a specific result). By setting the context, a combination of `type`, `id`, `comparisonType` and optionally a `comparisonId`, the desired results can be retrieved.
## Averages
`GET` `https://api-portal.evalytics.nl/result/averages`
Returns a list of total averages within the given context (e.g. an evaluation).
#### Query Parameters
| Name | Type | Description |
| ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| element | array | Determines which results the API will return.
Possible values:
totalAverage, subjectAverage, teacherAverage, examAverage, genericAverage
|
| type | string | Context in which results are being searched.
Possible values:organisation, evaluation, teacher, subject
|
| id | integer | Use in combination with `type` to retrieve results from within specific context. E.g. if `type` if set to `evaluation`, given `id` must be an evaluation id. |
| comparisonType | string | Further defines the context. E.g. if an evaluation has multiple teachers, this can be used to get results for a specific teacher within that evaluation.
Possible values:
organisation, evaluation, teacher, subject
|
| comparisonId | integer | Use in combination with `comparisonType` to retrieve results within the sub context. |
| startDate | string | Uses the format `YYYY-MM-DD` |
| endDate | string | Uses the format `YYYY-MM-DD` |
| includeChildOrganisations | boolean | By default only results for the organisation present in the `accessToken` are retrieved. By setting this to `true`, results for child organisations will also be returned if available. |
{% tabs %}
{% tab title="200 " %}
```scheme
{
"name": string,
"averages": [
{
"type": string,
"average": number
}
]
}
```
{% endtab %}
{% endtabs %}
## Average history
`GET` `https://api-portal.evalytics.nl/result/averageHistory`
Returns a list of averages per quarter, per type, within the given context. Note that this only works if the context supports history, i.e. not for evaluations.
#### Query Parameters
| Name | Type | Description |
| ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| element | string | Determines which results the API will return.
Possible values:
totalAverage, subjectAverage, teacherAverage, examAverage, genericAverage
|
| type | string | Context in which results are being searched.
Possible values:organisation, subject, teacher
|
| id | integer | Use in combination with `type` to retrieve results from within specific context. E.g. if `type` if set to `evaluation`, given `id` must be an evaluation id. |
| comparisonType | string | Further defines the context. E.g. if an evaluation has multiple teachers, this can be used to get results for a specific teacher within that evaluation.
Possible values:
organisation, teacher, subject
|
| comparisonId | integer | Use in combination with `comparisonType` to retrieve results within the sub context. |
| startDate | string | Uses the format `YYYY-MM-DD` |
| endDate | string | Uses the format `YYYY-MM-DD` |
| includeChildOrganisations | boolean | By default only results for the organisation present in the `accessToken` are retrieved. By setting this to `true`, results for child organisations will also be returned if available. |
{% tabs %}
{% tab title="200 " %}
```scheme
[
{
"type": string,
"history": [
{
"average": number,
"quarter": integer,
"year": integer
}
]
}
]
```
{% endtab %}
{% endtabs %}
## List
`GET` `https://api-portal.evalytics.nl/result/list`
Returns a list of items with their average results for the given context (e.g. a list of evaluations for an organisation).
#### Query Parameters
| Name | Type | Description |
| ------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| element | array | Determines which results the API will return.
Possible values:
totalAverage, subjectAverage, teacherAverage, examAverage, genericAverage
|
| type\* | string | Context in which results are being searched.
Possible values:organisation, evaluation, teacher, subject
|
| id | integer | Use in combination with `type` to retrieve results from within specific context. E.g. if `type` if set to `evaluation`, given `id` must be an evaluation id. |
| comparisonType\* | string | Further defines the context. E.g. if an evaluation has multiple teachers, this can be used to get results for a specific teacher within that evaluation.
Possible values:
organisation, evaluation, teacher, subject
|
| comparisonId | integer | Use in combination with `comparisonType` to retrieve results within the sub context. |
| startDate | string | Uses the format `YYYY-MM-DD` |
| endDate | string | Uses the format `YYYY-MM-DD` |
| searchQuery | string | |
| includeChildOrganisations | boolean | By default only results for the organisation present in the `accessToken` are retrieved. By setting this to `true`, results for child organisations will also be returned if available. |
| skip | integer | Defaults to `0` |
| limit | integer | Defaults to `30` |
| orderBy | string | Possible values:
name ASC, name DESC, totalAverage ASC, totalAverage DESC, subjectAverage ASC, subjectAverage DESC, teacherAverage ASC, teacherAverage DESC, examAverage ASC, examAverage DESC, enddate ASC, enddate DESC
|
{% tabs %}
{% tab title="200 Note that the response can have minor differences depending on the context. E.g. if the context is a teacher, only a teacherAverage will be present." %}
```scheme
{
"metadata": {
"resultSet": {
"count": integer,
"limit": integer,
"skip": integer
}
},
"results": [
{
"id": integer,
"name": string,
"code": string,
"evaluations": integer,
"totalAverage": number,
"teacherPersonalAverage": number,
"examAverage": number,
"teacherAverage": number,
"subjectAverage": number,
"response": integer,
"expectedResponse": integer
}
]
}
```
{% endtab %}
{% endtabs %}
## Questions
`GET` `https://api-portal.evalytics.nl/result/questions`
Returns a list of questions with their average results for the given context (e.g. a list of questions for a specific evaluation).
#### Query Parameters
| Name | Type | Description |
| -------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| element | array | Determines which results the API will return.
Possible values:
subjectQuestions, teacherQuestions, examQuestions, genericQuestions
|
| type\* | string | Context in which results are being searched.
Possible values:organisation, evaluation, teacher, subject
|
| id | integer | Use in combination with `type` to retrieve results from within specific context. E.g. if `type` if set to `evaluation`, given `id` must be an evaluation id. |
| comparisonType | string | Further defines the context. E.g. if an evaluation has multiple teachers, this can be used to get results for a specific teacher within that evaluation.
Possible values:
organisation, evaluation, teacher, subject
|
| comparisonId | integer | Use in combination with `comparisonType` to retrieve results within the sub context. |
| startDate | string | Uses the format `YYYY-MM-DD` |
| endDate | string | Uses the format `YYYY-MM-DD` |
| includedInAverage | boolean | By default all question results are retrieved. By setting this to `true`, only questions that count towards global averages will be returned. |
| includeChildOrganisations | boolean | By default only results for the organisation present in the `accessToken` are retrieved. By setting this to `true`, results for child organisations will also be returned if available. |
| orderBy | string | Possible values:
question ASC, question DESC
|
{% tabs %}
{% tab title="200 " %}
```scheme
{
"questionGroups": [
{
"name": string,
"questions": [
{
"typeId": integer,
"hash": string,
"code": string
"type": integer,
"topicType": integer,
"questionType": integer,
"isIncludedInAverage": boolean,
"response": integer,
"scale": {
"name": string,
"scale": object,
"input": string
},
"question": string,
"average": number,
"deviation": number
}
]
}
],
"hasLabels": boolean
}
```
{% endtab %}
{% endtabs %}
## Question
`GET` `https://api-portal.evalytics.nl/result/question/:hash`
Returns a single question with it's average result and result distribution for the given context (e.g. a single topic question).
#### Path Parameters
| Name | Type | Description |
| ---- | ------ | ------------------- |
| hash | string | The question's hash |
#### Query Parameters
| Name | Type | Description |
| ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type | string | Context in which results are being searched.
Possible values:organisation, evaluation, teacher, subject
|
| id | integer | Use in combination with `type` to retrieve results from within specific context. E.g. if `type` if set to `evaluation`, given `id` must be an evaluation id. |
| comparisonType | string | Further defines the context. E.g. if an evaluation has multiple teachers, this can be used to get results for a specific teacher within that evaluation.
Possible values:
organisation, evaluation, teacher, subject
|
| comparisonId | integer | Use in combination with `comparisonType` to retrieve results within the sub context. |
| startDate | string | Uses the format `YYYY-MM-DD` |
| endDate | string | Uses the format `YYYY-MM-DD` |
| includeChildOrganisations | boolean | By default only results for the organisation present in the `accessToken` are retrieved. By setting this to `true`, results for child organisations will also be returned if available. |
{% tabs %}
{% tab title="200 " %}
```scheme
{
"typeId": integer,
"hash": string,
"code": string,
"type": integer,
"topicType": integer,
"response": integer,
"scale": {
"name": string,
"scale": object,
"input": string
},
"question": string,
"scoreDistribution": object,
"average": number,
"deviation": number,
"averageIndex": integer,
"explanations": array
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://doc.evalytics.nl/onderdelen/results.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.