Skip to content
API Reference
/
ai-analytics
/
ai_analytics_overview_orgs_average_grade_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

ai_analytics_overview_orgs_active_users_retrieve

Request

Get active user counts over time.

This endpoint provides daily counts of active users (users with known activity) over a specified time period.

Query Parameters: start_date (str, optional): Start date for the time range (ISO format) end_date (str, optional): End date for the time range (ISO format)

Returns: Daily active user counts over the specified time period, with change metrics compared to previous periods.

Default time range is the last 7 days if no dates are specified.

An active user is defined as a user with any activity within the past 30 days.

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

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

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

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/overview/orgs/{org}/active-users?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject

Dates are keys and values are the value for the date in the key. e,g {"2020-01-01": 30. ...}

totalinteger

Total

metaobject(OvertimeMeta)required
meta.​totalintegerrequired

Total records

meta.​change_rangeinteger

Change in range

Default 0
meta.​change_last_seven_daysinteger

Change in last 7 days

Default 0
meta.​change_last_thirty_daysinteger

Change in last 30 days

Default 0
meta.​change_last_seven_days_percentnumber(double)

Change in last 7 days in percentage

Default 0
meta.​change_last_thirty_days_percentnumber(double)

Change in last 30 days in percentage

Default 0
meta.​change_range_percentnumber(double)

Change in range in percentage

Response
application/json
{
  "data": {
    "property1": null,
    "property2": null
  },
  "total": 0,
  "meta": {
    "total": 0,
    "change_range": 0,
    "change_last_seven_days": 0,
    "change_last_thirty_days": 0,
    "change_last_seven_days_percent": 0,
    "change_last_thirty_days_percent": 0,
    "change_range_percent": 0.1
  }
}

ai_analytics_overview_orgs_average_grade_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/ai-analytics/overview/orgs/{org}/average-grade?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_analytics_overview_orgs_courses_completions_retrieve

Request

Get course completion summary metrics over time.

This endpoint provides completion statistics across the platform over a specified time period, including daily completion counts and overall metrics.

Query Parameters: start_date (str): Start date for the time range (ISO format) end_date (str): End date for the time range (ISO format)

Returns: Completion data including:

  • Daily completion counts over time
  • Total unique user count
  • Total completion count
  • Completion percentage
  • Change metrics compared to previous periods

Default time range is the last 7 days if no dates are specified.

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

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

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

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/overview/orgs/{org}/courses/completions?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject(CourseCompletionSummaryDataOvertime)required
data.​overtimeobject

Dates are keys and values are the value for the date in the key. e,g {"2020-01-01": 30. ...}

data.​total_user_countintegerrequired

Total unique active users in this period

data.​completed_countintegerrequired

Total course completions

data.​completed_percentnumber(double)required

Completion percent for the time range

metaobject(OvertimeMeta)required
meta.​totalintegerrequired

Total records

meta.​change_rangeinteger

Change in range

Default 0
meta.​change_last_seven_daysinteger

Change in last 7 days

Default 0
meta.​change_last_thirty_daysinteger

Change in last 30 days

Default 0
meta.​change_last_seven_days_percentnumber(double)

Change in last 7 days in percentage

Default 0
meta.​change_last_thirty_days_percentnumber(double)

Change in last 30 days in percentage

Default 0
meta.​change_range_percentnumber(double)

Change in range in percentage

Response
application/json
{
  "data": {
    "overtime": { … },
    "total_user_count": 0,
    "completed_count": 0,
    "completed_percent": 0.1
  },
  "meta": {
    "total": 0,
    "change_range": 0,
    "change_last_seven_days": 0,
    "change_last_thirty_days": 0,
    "change_last_seven_days_percent": 0,
    "change_last_thirty_days_percent": 0,
    "change_range_percent": 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