Skip to content
API Reference
/
ai-analytics
/
performance_orgs_courses_grading_summary_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

performance_orgs_courses_grading_per_learner_retrieve

Request

Grading information per enrolled user in a course

Kwargs course_id

Security
PlatformApiKeyAuthentication
Path
course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required
orgstringrequired
Query
department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/performance/orgs/{org}/courses/{course_id}/grading/per-learner?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects(GradingPerUserData)
totalinteger

Total rows

Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

performance_orgs_courses_grading_summary_retrieve

Request

Returns average grades across various assignment types in a course

Query Params course_id

Returns: dict { "data": [ { "assignment_type': , "weight": , "average_weighted_grade": , "average_section_grade": }, ... ] }

Security
PlatformApiKeyAuthentication
Path
course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required
orgstringrequired
Query
department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/performance/orgs/{org}/courses/{course_id}/grading/summary?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects(CourseGradeSummaryData)
Response
application/json
{
  "data": [
    { … }
  ]
}

performance_orgs_grading_average_retrieve

Request

Get average grade value for platform, course, or user.

This endpoint returns the average grade at different levels:

  • Platform level: Average grade across all courses
  • Course level: Average grade for a specific course
  • Learner level: Average grade for a specific learner
  • Course-learner level: Grade for a specific learner in a specific course

Query Parameters: course_id (str, optional): Filter by course ID learner_id (str, optional): Filter by username or email

Returns: The average grade value based on the specified filters.

Access Control:

  • Platform admins can access any grade data
  • Learners can access their own grade data
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/performance/orgs/{org}/grading/average?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject(AverageData)required
data.​averagenumber(double)required

Average

Response
application/json
{
  "data": {
    "average": 0.1
  }
}

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com