OverviewApi class

Constructors

OverviewApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
overviewOrgsActiveUsersRetrieve(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<OvertimeWithChangeInfo?>
Count of users with known activity within the past 30 days on a per day basis Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive) Returns ``` { "data": { "2022-04-26": 0, "2022-04-27": 0, "2022-04-28": 0, "2022-04-29": 60, ... "2022-05-05": 0 }, "total": 60, "meta": { "change_last_seven_days": 0, "change_last_seven_days_percent": 0.0, "change_last_thirty_days": 0, "change_last_thirty_days_percent": 0.0, "change_range": 0, "change_range_percent": 0.0, "total": 0, } }
overviewOrgsActiveUsersRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Count of users with known activity within the past 30 days on a per day basis Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive) Returns ``` { "data": { "2022-04-26": 0, "2022-04-27": 0, "2022-04-28": 0, "2022-04-29": 60, ... "2022-05-05": 0 }, "total": 60, "meta": { "change_last_seven_days": 0, "change_last_seven_days_percent": 0.0, "change_last_thirty_days": 0, "change_last_thirty_days_percent": 0.0, "change_range": 0, "change_range_percent": 0.0, "total": 0, } }
overviewOrgsAverageGradeRetrieve(String org, {String? format, int? groupId}) → Future<Average?>
Average grade value for platform, course, or user. Query Params course_id
overviewOrgsAverageGradeRetrieveWithHttpInfo(String org, {String? format, int? groupId}) → Future<Response>
Average grade value for platform, course, or user. Query Params course_id
overviewOrgsCoursesCompletionsRetrieve(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<CourseCompletionSummaryOvertime?>
Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
overviewOrgsCoursesCompletionsRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
overviewOrgsLearnersRetrieve(String org, {String? format, int? groupId, int? length, int? page, String? search}) → Future<PerlearnerUserList?>
List of entire learners on the platform with aggregated enrollments, completions and time spent
overviewOrgsLearnersRetrieveWithHttpInfo(String org, {String? format, int? groupId, int? length, int? page, String? search}) → Future<Response>
List of entire learners on the platform with aggregated enrollments, completions and time spent
overviewOrgsMostActiveCoursesRetrieve(String org, {String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<TimeSpentPerCourse?>
Aggregated time spent value on a per course basis
overviewOrgsMostActiveCoursesRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<Response>
Aggregated time spent value on a per course basis
overviewOrgsRegisteredUsersRetrieve(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<OvertimeWithChangeInfo?>
Registered users count on a per day basis Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
overviewOrgsRegisteredUsersRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Registered users count on a per day basis Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited