AudienceApi class

Constructors

AudienceApi([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

audienceOrgsActiveUsersOverTimeRetrieve(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, } }
audienceOrgsActiveUsersOverTimeRetrieveWithHttpInfo(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, } }
audienceOrgsActiveUsersPerCourseRetrieve(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<ActiveUsersPerCourse?>
Count of users with known activity within specified date_range on a per-course 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)
audienceOrgsActiveUsersPerCourseRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Count of users with known activity within specified date_range on a per-course 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)
audienceOrgsActiveUsersUsersRetrieve(String org, {String? format, int? groupId, int? length, int? page}) → Future<ActiveUsersList?>
List of users with known activity within the specified date range default is all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 3. course_id
audienceOrgsActiveUsersUsersRetrieveWithHttpInfo(String org, {String? format, int? groupId, int? length, int? page}) → Future<Response>
List of users with known activity within the specified date range default is all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 3. course_id
audienceOrgsEnrollmentsCoursesOverTimeRetrieve(String courseId, String org, {String? active, String? endDate, String? format, int? groupId, String? startDate}) → Future<OvertimeWithChangeInfo?>
Aggregated count of new enrollments/ unenrollments on a per day basis Params 1. course_id
audienceOrgsEnrollmentsCoursesOverTimeRetrieveWithHttpInfo(String courseId, String org, {String? active, String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Aggregated count of new enrollments/ unenrollments on a per day basis Params 1. course_id
audienceOrgsEnrollmentsCoursesUsersRetrieve(String courseId, String org, {String? active, String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<EnrollmentsPerUser?>
List of users who are enrolled/not enrolled in specified course Query Params 1. course_id 2. active e.g true/false would mean not active enrollments
audienceOrgsEnrollmentsCoursesUsersRetrieveWithHttpInfo(String courseId, String org, {String? active, String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<Response>
List of users who are enrolled/not enrolled in specified course Query Params 1. course_id 2. active e.g true/false would mean not active enrollments
audienceOrgsEnrollmentsOverTimeRetrieve(String org, {String? active, String? endDate, String? format, int? groupId, String? startDate}) → Future<OvertimeWithChangeInfo?>
Aggregated count of new enrollments/ unenrollments on a per day basis Params 1. course_id
audienceOrgsEnrollmentsOverTimeRetrieveWithHttpInfo(String org, {String? active, String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Aggregated count of new enrollments/ unenrollments on a per day basis Params 1. course_id
audienceOrgsEnrollmentsPerCourseRetrieve(String org, {String? active, String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<Enrollments?>
Aggregated count of active/inactive enrollments on a per course basis Query Params active e.g true/false would mean not active enrollments
audienceOrgsEnrollmentsPerCourseRetrieveWithHttpInfo(String org, {String? active, String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<Response>
Aggregated count of active/inactive enrollments on a per course basis Query Params active e.g true/false would mean not active enrollments
audienceOrgsRegisteredUsersOverTimeRetrieve(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)
audienceOrgsRegisteredUsersOverTimeRetrieveWithHttpInfo(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)
audienceOrgsRegisteredUsersPerCourseRetrieve(String org, {String? active, String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<Enrollments?>
Aggregated count of active/inactive enrollments on a per course basis Query Params active e.g true/false would mean not active enrollments
audienceOrgsRegisteredUsersPerCourseRetrieveWithHttpInfo(String org, {String? active, String? endDate, String? format, int? groupId, int? length, int? page, String? startDate}) → Future<Response>
Aggregated count of active/inactive enrollments on a per course basis Query Params active e.g true/false would mean not active enrollments
audienceOrgsRegisteredUsersRetrieve(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
audienceOrgsRegisteredUsersRetrieveWithHttpInfo(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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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