audienceOrgsEnrollmentsOverTimeRetrieveWithHttpInfo method

Future<Response> audienceOrgsEnrollmentsOverTimeRetrieveWithHttpInfo(
  1. String org, {
  2. String? active,
  3. String? endDate,
  4. String? format,
  5. int? groupId,
  6. String? startDate,
})

Aggregated count of new enrollments/ unenrollments on a per day basis Params 1. course_id

Note: This method returns the HTTP Response.

Parameters:

  • String org (required):

  • String active: Any of y, yes, true. set to false or no for unenrollments * y - y * yes - yes * true - true * True - True * n - n * no - no * false - false * False - False

  • String endDate: end date. ISO 8601

  • String format: Format * json - json

  • int groupId: Cohort Group ID

  • String startDate: start date. ISO 8601

Implementation

Future<Response> audienceOrgsEnrollmentsOverTimeRetrieveWithHttpInfo(String org, { String? active, String? endDate, String? format, int? groupId, String? startDate, }) async {
  // ignore: prefer_const_declarations
  final path = r'/api/audience/orgs/{org}/enrollments/over-time'
    .replaceAll('{org}', org);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (active != null) {
    queryParams.addAll(_queryParams('', 'active', active));
  }
  if (endDate != null) {
    queryParams.addAll(_queryParams('', 'end_date', endDate));
  }
  if (format != null) {
    queryParams.addAll(_queryParams('', 'format', format));
  }
  if (groupId != null) {
    queryParams.addAll(_queryParams('', 'group_id', groupId));
  }
  if (startDate != null) {
    queryParams.addAll(_queryParams('', 'start_date', startDate));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}