@mitodl/ol-analytics-dashboard-api-axios 0.0.0-stage → 2026.10.20-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/LICENSE +29 -0
  2. package/dist/cjs/api.d.ts +1868 -0
  3. package/dist/cjs/api.d.ts.map +1 -0
  4. package/dist/cjs/api.js +1536 -0
  5. package/dist/cjs/api.js.map +1 -0
  6. package/dist/cjs/base.d.ts +43 -0
  7. package/dist/cjs/base.d.ts.map +1 -0
  8. package/dist/cjs/base.js +50 -0
  9. package/dist/cjs/base.js.map +1 -0
  10. package/dist/cjs/common.d.ts +35 -0
  11. package/dist/cjs/common.d.ts.map +1 -0
  12. package/dist/cjs/common.js +140 -0
  13. package/dist/cjs/common.js.map +1 -0
  14. package/dist/cjs/configuration.d.ts +99 -0
  15. package/dist/cjs/configuration.d.ts.map +1 -0
  16. package/dist/cjs/configuration.js +45 -0
  17. package/dist/cjs/configuration.js.map +1 -0
  18. package/dist/cjs/index.d.ts +14 -0
  19. package/dist/cjs/index.d.ts.map +1 -0
  20. package/dist/cjs/index.js +32 -0
  21. package/dist/cjs/index.js.map +1 -0
  22. package/dist/esm/api.d.ts +1868 -0
  23. package/dist/esm/api.d.ts.map +1 -0
  24. package/dist/esm/api.js +1510 -0
  25. package/dist/esm/api.js.map +1 -0
  26. package/dist/esm/base.d.ts +43 -0
  27. package/dist/esm/base.d.ts.map +1 -0
  28. package/dist/esm/base.js +42 -0
  29. package/dist/esm/base.js.map +1 -0
  30. package/dist/esm/common.d.ts +35 -0
  31. package/dist/esm/common.d.ts.map +1 -0
  32. package/dist/esm/common.js +127 -0
  33. package/dist/esm/common.js.map +1 -0
  34. package/dist/esm/configuration.d.ts +99 -0
  35. package/dist/esm/configuration.d.ts.map +1 -0
  36. package/dist/esm/configuration.js +41 -0
  37. package/dist/esm/configuration.js.map +1 -0
  38. package/dist/esm/index.d.ts +14 -0
  39. package/dist/esm/index.d.ts.map +1 -0
  40. package/dist/esm/index.js +16 -0
  41. package/dist/esm/index.js.map +1 -0
  42. package/package.json +37 -3
  43. package/README.md +0 -3
@@ -0,0 +1,1868 @@
1
+ /**
2
+ * B2B Analytics Dashboard
3
+ * B2B site-license analytics for org managers and MIT contract admins. Aggregate endpoints apply a k-anonymity floor. The contract-scoped learner-progress endpoint returns individual learners on the organization\'s own seats, with outcome fields consent-gated.
4
+ *
5
+ * The version of the OpenAPI document: 0.0.1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
+ export interface AdminAnalyticsResponseMitAdminContractHealth {
17
+ 'as_of': string | null;
18
+ 'total_count': number;
19
+ 'data': Array<MitAdminContractHealth>;
20
+ }
21
+ /**
22
+ * ``passed`` without ``certified`` is normal: certificates are issued on a schedule after grading, and audit-mode enrollments never certify.
23
+ */
24
+ export declare const CompletionStatus: {
25
+ readonly NotStarted: "not_started";
26
+ readonly InProgress: "in_progress";
27
+ readonly Passed: "passed";
28
+ readonly Certified: "certified";
29
+ };
30
+ export type CompletionStatus = typeof CompletionStatus[keyof typeof CompletionStatus];
31
+ /**
32
+ * Matches ``LearnerProgressResponse.total_count``\'s own filters, not the contract as a whole, so it narrows along with the table it summarizes. Each field counts a disjoint slice of the matching enrollments: every enrollment falls into exactly one, in the order below (certificate beats grade beats activity beats neither), so summing the four plus ``outcomes_withheld_count`` always equals ``total_count``. An unrevoked certificate always wins even when the same enrollment also carries a passing or in-progress grade, which is why each field\'s own description calls out what it excludes. These counts are never suppressed for small cohorts, unlike the ``cohort_policy``-gated aggregates elsewhere in b2b_analytics (e.g. ``ContractUtilization``, ``EnrollmentCompletionFunnel``): this endpoint\'s ``data`` already exposes the individual matching rows, so there\'s nothing left to hide by suppressing the summary.
33
+ */
34
+ export interface CompletionStatusCounts {
35
+ /**
36
+ * Matching enrollments with an unrevoked certificate, whatever their grade.
37
+ */
38
+ 'certified': number;
39
+ /**
40
+ * Matching enrollments with a currently passing grade, other than those already counted as certified above.
41
+ */
42
+ 'passed': number;
43
+ /**
44
+ * Matching enrollments with a nonzero grade that isn\'t yet passing, or with no grade yet but some activity in the course, other than those already counted as certified or passed above.
45
+ */
46
+ 'in_progress': number;
47
+ /**
48
+ * Matching enrollments with no certificate, no grade, and no activity in the course yet.
49
+ */
50
+ 'not_started': number;
51
+ }
52
+ export declare const CompletionStatusFilter: {
53
+ readonly NotStarted: "not_started";
54
+ readonly InProgress: "in_progress";
55
+ readonly Passed: "passed";
56
+ readonly Certified: "certified";
57
+ readonly Unknown: "unknown";
58
+ };
59
+ export type CompletionStatusFilter = typeof CompletionStatusFilter[keyof typeof CompletionStatusFilter];
60
+ /**
61
+ * ``not_recorded`` = the learner has not answered. ``declined`` covers a learner who answered no and one who consented and later withdrew: MITx Online keeps one nullable boolean per (learner, contract).
62
+ */
63
+ export declare const ConsentStatus: {
64
+ readonly Consented: "consented";
65
+ readonly Declined: "declined";
66
+ readonly NotRecorded: "not_recorded";
67
+ };
68
+ export type ConsentStatus = typeof ConsentStatus[keyof typeof ConsentStatus];
69
+ /**
70
+ * mv_b2b_content_engagement_depth — grain: org x course_run (all-time). The chatbot columns are exact: ``total_chatbot_interactions`` sums over, and ``chatbot_adoption_pct`` divides by, ``chatbot_users`` — which this view does emit, so both are correctly floored. ``engagement_rate_pct`` is ``engaged_learners / total_enrolled_learners``, also correct. The video and problem columns are floored through the cohorts the view now publishes (ol-data-platform PR #2520): ``total_videos_watched`` is summed over ``video_watchers`` and ``total_problems_attempted`` over ``problem_attempters``, each a strict subset of ``engaged_learners`` because watching a video or attempting a problem is tracked activity. ``chatbot_users`` is one too. That is a property of these particular cohorts, not a general rule: a certified learner need not be engaged, and see ``MonthlyEngagementTrend``, where neither ``enrolling_learners`` nor ``certified_learners`` is a subset of ``monthly_active_learners``. The ``avg_*_per_engaged_learner`` columns are derived from *two* cohorts, which is why each names both. The denominator is ``engaged_learners`` — that is what the dbt SQL divides by, so the naming is now accurate — but the numerator is the activity SUM, contributed by only the narrower cohort. Mapping the average to its denominator alone would leave the numerator recoverable: an unsuppressed average multiplied by a published ``engaged_learners`` yields the suppressed total exactly, and when the contributing cohort is a single learner that total *is* that learner\'s value. Naming both cohorts nulls the average whenever either is sub-floor. ``certificates_earned`` counts learners holding an unrevoked certificate for the run, whether or not their enrollment is still active (ol-data-platform PR #2913). So it is not a subset of ``total_enrolled_learners``: a learner who certified and then unenrolled is counted here and not there. It is declared contained in it anyway, so besides its own floor it is withheld when the gap (enrolled minus certified) is below the floor and not 0, including below zero. That gap is the uncertified enrolled learners minus the unenrolled certificate holders, never more than the true one, so the declaration over-suppresses on runs with unenrolled holders. A gap of exactly 0 is published even though it can hide as many uncertified enrolled learners as there are unenrolled holders. Each learner counts once per run at this grain. Since ol-data-platform PR #2982 every row of the progress fact carries the one contract the learner enrolled under, so a run offered under two contracts does not double the SUM.
71
+ */
72
+ export interface ContentEngagementDepth {
73
+ /**
74
+ * Internal identifier for the organization.
75
+ */
76
+ 'organization_key': string;
77
+ /**
78
+ * The organization\'s name.
79
+ */
80
+ 'organization_name': string;
81
+ /**
82
+ * The course run\'s ID, e.g. course-v1:MITxT+14.310x+2T2026.
83
+ */
84
+ 'courserun_readable_id': string;
85
+ /**
86
+ * The course\'s title.
87
+ */
88
+ 'courserun_title': string;
89
+ /**
90
+ * Learners who have ever enrolled in this course run. When too few learners are in the group, the whole row is withheld to avoid identifying them.
91
+ */
92
+ 'total_enrolled_learners': number;
93
+ /**
94
+ * Enrolled learners who did anything in the course: watched a video, attempted a problem, posted in a discussion, used the chatbot or moved through course pages. Withheld when too few learners are in the group to report without identifying them.
95
+ */
96
+ 'engaged_learners': number | null;
97
+ /**
98
+ * Percentage of enrolled learners who did anything in the course. Withheld when the learner count it is based on is withheld.
99
+ */
100
+ 'engagement_rate_pct': number | null;
101
+ /**
102
+ * Videos watched in this course run, counting every view. Withheld when the learner count it is based on is withheld.
103
+ */
104
+ 'total_videos_watched': number | null;
105
+ /**
106
+ * Learners who watched at least one video in this course run. Withheld when too few learners are in the group to report without identifying them.
107
+ */
108
+ 'video_watchers': number | null;
109
+ /**
110
+ * Average videos watched per learner who did anything in the course. Withheld when the learner count it is based on is withheld.
111
+ */
112
+ 'avg_videos_per_engaged_learner': number | null;
113
+ /**
114
+ * Problem attempts in this course run, counting every attempt. Withheld when the learner count it is based on is withheld.
115
+ */
116
+ 'total_problems_attempted': number | null;
117
+ /**
118
+ * Learners who attempted at least one problem in this course run. Withheld when too few learners are in the group to report without identifying them.
119
+ */
120
+ 'problem_attempters': number | null;
121
+ /**
122
+ * Average problem attempts per learner who did anything in the course. Withheld when the learner count it is based on is withheld.
123
+ */
124
+ 'avg_problems_per_engaged_learner': number | null;
125
+ /**
126
+ * Chatbot interactions in this course run. Withheld when the learner count it is based on is withheld.
127
+ */
128
+ 'total_chatbot_interactions': number | null;
129
+ /**
130
+ * Learners who used the chatbot in this course run. Withheld when too few learners are in the group to report without identifying them.
131
+ */
132
+ 'chatbot_users': number | null;
133
+ /**
134
+ * Percentage of enrolled learners who used the chatbot. Withheld when the learner count it is based on is withheld.
135
+ */
136
+ 'chatbot_adoption_pct': number | null;
137
+ /**
138
+ * Certificates earned in this course run. Withheld when too few learners are in the group to report without identifying them.
139
+ */
140
+ 'certificates_earned': number | null;
141
+ }
142
+ /**
143
+ * mv_b2b_contract_content_engagement_depth — grain: org x contract x run. The contract-scoped sibling of ``ContentEngagementDepth``, inherited for the same reason as ``ContractMonthlyEngagementTrend``. Unlike the trend view, these rows ARE a strict partition of the org-level view: a course run belongs to exactly one contract, so naming the contract labels a row rather than splitting it, and every count here equals its org-level counterpart for the same course run. That equality is why this pair needs no cross-grain guard, where the trend pair does. Nothing is aggregated away going from contract grain to org grain, so there is no remainder to subtract: a course run\'s org row and its contract row hold the same numbers, the floor makes the same call on both, and a caller reading one learns nothing the other withholds.
144
+ */
145
+ export interface ContractContentEngagementDepth {
146
+ /**
147
+ * Internal identifier for the organization.
148
+ */
149
+ 'organization_key': string;
150
+ /**
151
+ * The organization\'s name.
152
+ */
153
+ 'organization_name': string;
154
+ /**
155
+ * The course run\'s ID, e.g. course-v1:MITxT+14.310x+2T2026.
156
+ */
157
+ 'courserun_readable_id': string;
158
+ /**
159
+ * The course\'s title.
160
+ */
161
+ 'courserun_title': string;
162
+ /**
163
+ * Learners who have ever enrolled in this course run. When too few learners are in the group, the whole row is withheld to avoid identifying them.
164
+ */
165
+ 'total_enrolled_learners': number;
166
+ /**
167
+ * Enrolled learners who did anything in the course: watched a video, attempted a problem, posted in a discussion, used the chatbot or moved through course pages. Withheld when too few learners are in the group to report without identifying them.
168
+ */
169
+ 'engaged_learners': number | null;
170
+ /**
171
+ * Percentage of enrolled learners who did anything in the course. Withheld when the learner count it is based on is withheld.
172
+ */
173
+ 'engagement_rate_pct': number | null;
174
+ /**
175
+ * Videos watched in this course run, counting every view. Withheld when the learner count it is based on is withheld.
176
+ */
177
+ 'total_videos_watched': number | null;
178
+ /**
179
+ * Learners who watched at least one video in this course run. Withheld when too few learners are in the group to report without identifying them.
180
+ */
181
+ 'video_watchers': number | null;
182
+ /**
183
+ * Average videos watched per learner who did anything in the course. Withheld when the learner count it is based on is withheld.
184
+ */
185
+ 'avg_videos_per_engaged_learner': number | null;
186
+ /**
187
+ * Problem attempts in this course run, counting every attempt. Withheld when the learner count it is based on is withheld.
188
+ */
189
+ 'total_problems_attempted': number | null;
190
+ /**
191
+ * Learners who attempted at least one problem in this course run. Withheld when too few learners are in the group to report without identifying them.
192
+ */
193
+ 'problem_attempters': number | null;
194
+ /**
195
+ * Average problem attempts per learner who did anything in the course. Withheld when the learner count it is based on is withheld.
196
+ */
197
+ 'avg_problems_per_engaged_learner': number | null;
198
+ /**
199
+ * Chatbot interactions in this course run. Withheld when the learner count it is based on is withheld.
200
+ */
201
+ 'total_chatbot_interactions': number | null;
202
+ /**
203
+ * Learners who used the chatbot in this course run. Withheld when too few learners are in the group to report without identifying them.
204
+ */
205
+ 'chatbot_users': number | null;
206
+ /**
207
+ * Percentage of enrolled learners who used the chatbot. Withheld when the learner count it is based on is withheld.
208
+ */
209
+ 'chatbot_adoption_pct': number | null;
210
+ /**
211
+ * Certificates earned in this course run. Withheld when too few learners are in the group to report without identifying them.
212
+ */
213
+ 'certificates_earned': number | null;
214
+ /**
215
+ * Internal identifier for the contract.
216
+ */
217
+ 'contract_pk': string;
218
+ /**
219
+ * The contract\'s ID in MITx Online.
220
+ */
221
+ 'contract_id': number;
222
+ /**
223
+ * The contract\'s name.
224
+ */
225
+ 'b2b_contract_name': string;
226
+ }
227
+ /**
228
+ * mv_b2b_contract_monthly_engagement_trend — grain: org x contract x month. The contract-scoped sibling of ``MonthlyEngagementTrend``, backing the endpoints nested under a contract. Subclassed rather than redeclared so the two can\'t drift: the column set and the ``cohort_policy`` — which is what the anonymization floor reads — are inherited verbatim, and only contract identity is added. The dbt models are siblings in the same way. The contract columns are not cohorts and take no part in the policy. A learner active under two of an org\'s contracts appears in both rows, so these rows do not partition the org-level view\'s learner counts in general; summing ``monthly_active_learners`` across contracts can exceed the org\'s own figure. Activity totals, being sums of events, always add up — which is what makes a contract-month the floor withholds recoverable from the org endpoint as ``org_total - sum(the visible contract months)``. The org endpoint defends against that itself: it probes this view for the months it withholds and blanks its own additive totals for them (see ``routers.organizations._FinerGrain``). The learner counts don\'t get to skip that defense on the strength of \"not adding up in general\": two contracts that happen to share no learners *do* add up exactly, and a hidden one comes back from the visible sibling\'s total the same as a hidden event sum would. Nothing here can tell that case from an overlapping one, so the org endpoint guards every cohort column — not just the additive totals — for any month it hides anything for (``CrossGrainAdditives.guarded_cohorts``), accepting the cost of blanking counts that overlap would have made safe to publish.
229
+ */
230
+ export interface ContractMonthlyEngagementTrend {
231
+ /**
232
+ * Internal identifier for the organization.
233
+ */
234
+ 'organization_key': string;
235
+ /**
236
+ * The organization\'s name.
237
+ */
238
+ 'organization_name': string;
239
+ /**
240
+ * The month, e.g. 2026-08.
241
+ */
242
+ 'activity_year_and_month': string;
243
+ /**
244
+ * Learners who did course work this month: watched a video, attempted a problem, posted in a discussion, used the chatbot or moved through course pages. Enrolling or earning a certificate alone doesn\'t count. Withheld when too few learners are in the group to report without identifying them.
245
+ */
246
+ 'monthly_active_learners': number | null;
247
+ /**
248
+ * Course enrollments made this month. A learner who enrolled in six courses counts six times. Withheld when the learner count it is based on is withheld.
249
+ */
250
+ 'new_enrollments': number | null;
251
+ /**
252
+ * Learners who enrolled in at least one course this month. Withheld when too few learners are in the group to report without identifying them.
253
+ */
254
+ 'enrolling_learners': number | null;
255
+ /**
256
+ * Certificates earned this month. A learner who earned two counts twice. Withheld when the learner count it is based on is withheld.
257
+ */
258
+ 'certificates_earned': number | null;
259
+ /**
260
+ * Learners who earned at least one certificate this month. Withheld when too few learners are in the group to report without identifying them.
261
+ */
262
+ 'certified_learners': number | null;
263
+ /**
264
+ * Videos watched this month, counting every view. Withheld when the learner count it is based on is withheld.
265
+ */
266
+ 'total_videos_watched': number | null;
267
+ /**
268
+ * Learners who watched at least one video this month. Withheld when too few learners are in the group to report without identifying them.
269
+ */
270
+ 'video_watchers': number | null;
271
+ /**
272
+ * Problem attempts this month, counting every attempt. Withheld when the learner count it is based on is withheld.
273
+ */
274
+ 'total_problems_attempted': number | null;
275
+ /**
276
+ * Learners who attempted at least one problem this month. Withheld when too few learners are in the group to report without identifying them.
277
+ */
278
+ 'problem_attempters': number | null;
279
+ /**
280
+ * Chatbot interactions this month. Withheld when the learner count it is based on is withheld.
281
+ */
282
+ 'total_chatbot_interactions': number | null;
283
+ /**
284
+ * Learners who used the chatbot this month. Withheld when too few learners are in the group to report without identifying them.
285
+ */
286
+ 'chatbot_users': number | null;
287
+ /**
288
+ * Internal identifier for the contract.
289
+ */
290
+ 'contract_pk': string;
291
+ /**
292
+ * The contract\'s ID in MITx Online.
293
+ */
294
+ 'contract_id': number;
295
+ /**
296
+ * The contract\'s name.
297
+ */
298
+ 'b2b_contract_name': string;
299
+ }
300
+ /**
301
+ * Distinct learners needing attention — grain: org x contract. The one model here that does not mirror a materialized view. It is computed at query time by ``learner_queries.needs_attention_aggregate`` over ``b2b_learner_records.mv_b2b_learner_enrollment``, which is what lets the KPI tile and the learner directory beneath it share a single needs-attention expression and a single per-request date. A count column on ``mv_b2b_contract_utilization`` was the other candidate and was not chosen (decided 2026-10-02): it would have frozen the cutoff at MV-refresh time, so the tile and the directory could disagree about the same learner for up to a refresh interval. The rule itself has since moved to dbt in a form that avoids that. The MV publishes a per-enrollment ``needs_attention_since`` date and this query compares it to today, so the rule lives in one repo and the comparison still happens per request. Served from its own endpoint rather than folded into ``ContractUtilization`` because the MV behind it refreshes on its own schedule. One ``as_of`` per section is exactly what stops a lagging view from making another section look fresher than it is, so a client renders this tile\'s freshness from this endpoint\'s envelope, not from contract-utilization\'s. ``learners_considered`` is the primary cohort and gates the row. The other two counts are secondary, nulled on their own terms and when their complement within ``learners_considered`` is under the floor: 42 considered and 40 needing attention names the 2 who do not, so the 40 is withheld. A client has to render that as withheld, not as nobody needing attention.
302
+ */
303
+ export interface ContractNeedsAttention {
304
+ /**
305
+ * The contract\'s ID in MITx Online.
306
+ */
307
+ 'contract_id': number;
308
+ /**
309
+ * Learners with an active enrollment under the contract. Deactivated enrollments, such as after unenrolling or a refund, are left out. When too few learners are in the group, the whole row is withheld to avoid identifying them.
310
+ */
311
+ 'learners_considered': number;
312
+ /**
313
+ * Of those learners, how many may need a nudge: they never started a course, or their last recorded activity was at least 30 days ago. A learner counts once however many of the contract\'s courses they are behind in. Learners who haven\'t agreed to share their progress aren\'t counted. Withheld when too few learners are in the group to report without identifying them.
314
+ */
315
+ 'learners_needing_attention': number | null;
316
+ /**
317
+ * Of those learners, how many are left out of the count above because they haven\'t agreed to share their progress. Withheld when too few learners are in the group to report without identifying them.
318
+ */
319
+ 'learners_outcomes_withheld': number | null;
320
+ }
321
+ /**
322
+ * mv_b2b_contract_utilization — grain: org x contract. ``seats_consumed`` is the primary cohort. ``active_learners`` and ``certified_learners`` are secondary counts, nulled when nonzero but below the floor. ``completion_rate_pct`` is ``certified_learners`` over ``seats_consumed`` and is nulled with it. ``seat_utilization_pct`` is ``seats_consumed`` over ``seat_limit``, null when the limit is zero or null (the view divides by ``nullif(seat_limit, 0)``). ``learners_certified`` is the deprecated name for ``certified_learners``: always equal to it and floored the same way, kept until clients read the new name.
323
+ */
324
+ export interface ContractUtilization {
325
+ /**
326
+ * Internal identifier for the organization.
327
+ */
328
+ 'organization_key': string;
329
+ /**
330
+ * The organization\'s name.
331
+ */
332
+ 'organization_name': string;
333
+ /**
334
+ * Internal identifier for the contract.
335
+ */
336
+ 'contract_pk': string;
337
+ /**
338
+ * The contract\'s ID in MITx Online.
339
+ */
340
+ 'contract_id': number;
341
+ /**
342
+ * The contract\'s name.
343
+ */
344
+ 'b2b_contract_name': string;
345
+ /**
346
+ * Whether the contract is currently active.
347
+ */
348
+ 'b2b_contract_is_active': boolean;
349
+ /**
350
+ * When the contract starts. Empty if no start date is set.
351
+ */
352
+ 'b2b_contract_start_date': string | null;
353
+ /**
354
+ * When the contract ends. Empty if it has no end date.
355
+ */
356
+ 'b2b_contract_end_date': string | null;
357
+ /**
358
+ * How many seats the contract includes. Empty or zero means unlimited.
359
+ */
360
+ 'seat_limit': number | null;
361
+ /**
362
+ * The contract\'s membership type. Empty if not set.
363
+ */
364
+ 'b2b_contract_membership_type': string | null;
365
+ /**
366
+ * Learners enrolled in at least one course under the contract. When too few learners are in the group, the whole row is withheld to avoid identifying them.
367
+ */
368
+ 'seats_consumed': number;
369
+ /**
370
+ * Learners on the contract whose enrollment is still active. Withheld when too few learners are in the group to report without identifying them.
371
+ */
372
+ 'active_learners': number | null;
373
+ /**
374
+ * Learners on the contract who earned a certificate that hasn\'t been revoked. Withheld when too few learners are in the group to report without identifying them.
375
+ */
376
+ 'certified_learners': number | null;
377
+ /**
378
+ * Deprecated: use certified_learners, which this always equals.
379
+ */
380
+ 'learners_certified': number | null;
381
+ /**
382
+ * Percentage of the contract\'s seats in use. Empty when the contract has unlimited seats.
383
+ */
384
+ 'seat_utilization_pct': number | null;
385
+ /**
386
+ * Percentage of enrolled learners who earned a certificate. Withheld when the learner count it is based on is withheld.
387
+ */
388
+ 'completion_rate_pct': number | null;
389
+ }
390
+ /**
391
+ * One course run under the contract, for the learner-progress module filter.
392
+ */
393
+ export interface CourseRun {
394
+ /**
395
+ * The course run\'s ID, e.g. course-v1:MITxT+14.310x+2T2026.
396
+ */
397
+ 'courserun_id': string;
398
+ /**
399
+ * The course\'s title.
400
+ */
401
+ 'courserun_title': string;
402
+ /**
403
+ * When the course run starts. Empty if no start date is set.
404
+ */
405
+ 'courserun_start_on': string | null;
406
+ /**
407
+ * When the course run ends. Empty for self-paced courses.
408
+ */
409
+ 'courserun_end_on': string | null;
410
+ }
411
+ /**
412
+ * The org envelope (``organization_id``, ``as_of``, ``total_count``, ``data``), matching ``LearnerProgressResponse``\'s shape.
413
+ */
414
+ export interface CourseRunsResponse {
415
+ /**
416
+ * The organization\'s ID.
417
+ */
418
+ 'organization_id': string;
419
+ /**
420
+ * When the data was last updated. Empty before the first update.
421
+ */
422
+ 'as_of': string | null;
423
+ /**
424
+ * Course runs under the contract, across all pages.
425
+ */
426
+ 'total_count': number;
427
+ /**
428
+ * This page of course runs.
429
+ */
430
+ 'data': Array<CourseRun>;
431
+ }
432
+ /**
433
+ * mv_b2b_enrollment_completion_funnel — grain: org x contract x course_run. ``enrolled_learners`` is the primary cohort. ``active_rate_pct`` and ``completion_rate_pct`` are ``active_learners`` and ``certified_learners`` over ``enrolled_learners``, each nulled with its numerator.
434
+ */
435
+ export interface EnrollmentCompletionFunnel {
436
+ /**
437
+ * Internal identifier for the organization.
438
+ */
439
+ 'organization_key': string;
440
+ /**
441
+ * The organization\'s name.
442
+ */
443
+ 'organization_name': string;
444
+ /**
445
+ * Internal identifier for the contract.
446
+ */
447
+ 'contract_pk': string;
448
+ /**
449
+ * The contract\'s ID in MITx Online.
450
+ */
451
+ 'contract_id': number;
452
+ /**
453
+ * The contract\'s name.
454
+ */
455
+ 'b2b_contract_name': string;
456
+ /**
457
+ * Internal identifier for the course run.
458
+ */
459
+ 'courserun_pk': string;
460
+ /**
461
+ * The course run\'s ID, e.g. course-v1:MITxT+14.310x+2T2026.
462
+ */
463
+ 'courserun_readable_id': string;
464
+ /**
465
+ * The course\'s title.
466
+ */
467
+ 'courserun_title': string;
468
+ /**
469
+ * Learners enrolled in this course run. When too few learners are in the group, the whole row is withheld to avoid identifying them.
470
+ */
471
+ 'enrolled_learners': number;
472
+ /**
473
+ * Enrolled learners whose enrollment is still active. Withheld when too few learners are in the group to report without identifying them.
474
+ */
475
+ 'active_learners': number | null;
476
+ /**
477
+ * Enrolled learners with a passing grade. Withheld when too few learners are in the group to report without identifying them.
478
+ */
479
+ 'passing_learners': number | null;
480
+ /**
481
+ * Enrolled learners who earned a certificate that hasn\'t been revoked. Withheld when too few learners are in the group to report without identifying them.
482
+ */
483
+ 'certified_learners': number | null;
484
+ /**
485
+ * Percentage of enrolled learners whose enrollment is still active. Withheld when the learner count it is based on is withheld.
486
+ */
487
+ 'active_rate_pct': number | null;
488
+ /**
489
+ * Percentage of enrolled learners who earned a certificate. Withheld when the learner count it is based on is withheld.
490
+ */
491
+ 'completion_rate_pct': number | null;
492
+ }
493
+ export interface HTTPValidationError {
494
+ 'detail'?: Array<ValidationError>;
495
+ }
496
+ /**
497
+ * One enrollment in one course run under the contract. Holds the ``_gate_outcomes`` validator, so every model built from it gates outcomes the same way.
498
+ */
499
+ export interface LearnerEnrollment {
500
+ /**
501
+ * The course run\'s ID, e.g. course-v1:MITxT+14.310x+2T2026.
502
+ */
503
+ 'courserun_readable_id': string;
504
+ /**
505
+ * The course\'s title.
506
+ */
507
+ 'courserun_title': string;
508
+ /**
509
+ * When the course run starts. Empty if no start date is set.
510
+ */
511
+ 'courserun_start_on': string | null;
512
+ /**
513
+ * When the course run ends. Empty for self-paced courses.
514
+ */
515
+ 'courserun_end_on': string | null;
516
+ /**
517
+ * When the learner enrolled in this course run.
518
+ */
519
+ 'enrolled_on': string;
520
+ /**
521
+ * Whether the learner is still enrolled. False if the enrollment was deactivated, for example after unenrolling.
522
+ */
523
+ 'enrollment_is_active': boolean;
524
+ /**
525
+ * The enrollment track, for example verified or audit. Audit enrollments don\'t earn certificates.
526
+ */
527
+ 'enrollment_mode': string | null;
528
+ /**
529
+ * What the learner answered when asked to share their progress: consented, declined, or not recorded if they haven\'t answered yet. Always shown.
530
+ */
531
+ 'outcomes_consent_status': ConsentStatus;
532
+ /**
533
+ * Whether the learner has agreed to share their progress. If not, their status, grades, certificate and activity are hidden.
534
+ */
535
+ 'outcomes_shared': boolean;
536
+ /**
537
+ * Where the learner is in the course: not started, in progress, passed or certified. Hidden if the learner hasn\'t agreed to share their progress.
538
+ */
539
+ 'completion_status': CompletionStatus | null;
540
+ /**
541
+ * Whether the learner currently has a passing grade. Empty if no grade has been calculated yet. Hidden if the learner hasn\'t agreed to share their progress.
542
+ */
543
+ 'is_passing': boolean | null;
544
+ /**
545
+ * The learner\'s current grade, from 0 to 1. Hidden if the learner hasn\'t agreed to share their progress.
546
+ */
547
+ 'grade': number | null;
548
+ /**
549
+ * The learner\'s letter grade, when the course assigns one. Hidden if the learner hasn\'t agreed to share their progress.
550
+ */
551
+ 'letter_grade': string | null;
552
+ /**
553
+ * How much of the course content the learner has completed, from 0 to 1. Times 100 it is the percent complete on the course\'s progress page. It isn\'t the grade, so a learner can be certified below 1. Empty if the course has no content to count. Hidden if the learner hasn\'t agreed to share their progress.
554
+ */
555
+ 'content_progress': number | null;
556
+ /**
557
+ * When the learner\'s certificate was issued. Empty if they don\'t have one. Hidden if the learner hasn\'t agreed to share their progress.
558
+ */
559
+ 'certificate_issued_on': string | null;
560
+ /**
561
+ * Whether the learner\'s certificate was revoked. A revoked certificate doesn\'t count toward completion. Empty if they don\'t have one. Hidden if the learner hasn\'t agreed to share their progress.
562
+ */
563
+ 'certificate_is_revoked': boolean | null;
564
+ /**
565
+ * The last day the learner did anything in the course. Empty if they haven\'t yet. Hidden if the learner hasn\'t agreed to share their progress.
566
+ */
567
+ 'last_active_on': string | null;
568
+ /**
569
+ * Whether this learner may need a nudge: they never started the course, or they are still working through it and their last recorded activity was at least 30 days ago. False while they are passing or hold an unrevoked certificate, since going quiet after finishing is expected. Hidden if the learner hasn\'t agreed to share their progress.
570
+ */
571
+ 'needs_attention': boolean | null;
572
+ }
573
+ /**
574
+ * One learner\'s enrollment in one course run under the contract.
575
+ */
576
+ export interface LearnerProgress {
577
+ /**
578
+ * The learner\'s account ID. It stays the same if their email address changes.
579
+ */
580
+ 'learner_id': string;
581
+ /**
582
+ * The learner\'s email address. It may differ from the one they enrolled with.
583
+ */
584
+ 'email': string | null;
585
+ /**
586
+ * The learner\'s name, if they\'ve provided one.
587
+ */
588
+ 'full_name': string | null;
589
+ /**
590
+ * The course run\'s ID, e.g. course-v1:MITxT+14.310x+2T2026.
591
+ */
592
+ 'courserun_readable_id': string;
593
+ /**
594
+ * The course\'s title.
595
+ */
596
+ 'courserun_title': string;
597
+ /**
598
+ * When the course run starts. Empty if no start date is set.
599
+ */
600
+ 'courserun_start_on': string | null;
601
+ /**
602
+ * When the course run ends. Empty for self-paced courses.
603
+ */
604
+ 'courserun_end_on': string | null;
605
+ /**
606
+ * When the learner enrolled in this course run.
607
+ */
608
+ 'enrolled_on': string;
609
+ /**
610
+ * Whether the learner is still enrolled. False if the enrollment was deactivated, for example after unenrolling.
611
+ */
612
+ 'enrollment_is_active': boolean;
613
+ /**
614
+ * The enrollment track, for example verified or audit. Audit enrollments don\'t earn certificates.
615
+ */
616
+ 'enrollment_mode': string | null;
617
+ /**
618
+ * What the learner answered when asked to share their progress: consented, declined, or not recorded if they haven\'t answered yet. Always shown.
619
+ */
620
+ 'outcomes_consent_status': ConsentStatus;
621
+ /**
622
+ * Whether the learner has agreed to share their progress. If not, their status, grades, certificate and activity are hidden.
623
+ */
624
+ 'outcomes_shared': boolean;
625
+ /**
626
+ * Where the learner is in the course: not started, in progress, passed or certified. Hidden if the learner hasn\'t agreed to share their progress.
627
+ */
628
+ 'completion_status': CompletionStatus | null;
629
+ /**
630
+ * Whether the learner currently has a passing grade. Empty if no grade has been calculated yet. Hidden if the learner hasn\'t agreed to share their progress.
631
+ */
632
+ 'is_passing': boolean | null;
633
+ /**
634
+ * The learner\'s current grade, from 0 to 1. Hidden if the learner hasn\'t agreed to share their progress.
635
+ */
636
+ 'grade': number | null;
637
+ /**
638
+ * The learner\'s letter grade, when the course assigns one. Hidden if the learner hasn\'t agreed to share their progress.
639
+ */
640
+ 'letter_grade': string | null;
641
+ /**
642
+ * How much of the course content the learner has completed, from 0 to 1. Times 100 it is the percent complete on the course\'s progress page. It isn\'t the grade, so a learner can be certified below 1. Empty if the course has no content to count. Hidden if the learner hasn\'t agreed to share their progress.
643
+ */
644
+ 'content_progress': number | null;
645
+ /**
646
+ * When the learner\'s certificate was issued. Empty if they don\'t have one. Hidden if the learner hasn\'t agreed to share their progress.
647
+ */
648
+ 'certificate_issued_on': string | null;
649
+ /**
650
+ * Whether the learner\'s certificate was revoked. A revoked certificate doesn\'t count toward completion. Empty if they don\'t have one. Hidden if the learner hasn\'t agreed to share their progress.
651
+ */
652
+ 'certificate_is_revoked': boolean | null;
653
+ /**
654
+ * The last day the learner did anything in the course. Empty if they haven\'t yet. Hidden if the learner hasn\'t agreed to share their progress.
655
+ */
656
+ 'last_active_on': string | null;
657
+ /**
658
+ * Whether this learner may need a nudge: they never started the course, or they are still working through it and their last recorded activity was at least 30 days ago. False while they are passing or hold an unrevoked certificate, since going quiet after finishing is expected. Hidden if the learner hasn\'t agreed to share their progress.
659
+ */
660
+ 'needs_attention': boolean | null;
661
+ }
662
+ /**
663
+ * The org envelope (``organization_id``, ``as_of``, ``total_count``, ``data``) plus ``outcomes_withheld_count``, so a client can show how many rows carry withheld outcomes without paging through all of them.
664
+ */
665
+ export interface LearnerProgressResponse {
666
+ /**
667
+ * The organization\'s ID.
668
+ */
669
+ 'organization_id': string;
670
+ /**
671
+ * When the data was last updated. Empty before the first update.
672
+ */
673
+ 'as_of': string | null;
674
+ /**
675
+ * Matching enrollments across all pages, not just this one.
676
+ */
677
+ 'total_count': number;
678
+ /**
679
+ * How many of those enrollments have progress hidden because the learner hasn\'t agreed to share it.
680
+ */
681
+ 'outcomes_withheld_count': number;
682
+ /**
683
+ * How many of those enrollments are in each stage of completion. Enrollments with hidden progress aren\'t counted in any stage.
684
+ */
685
+ 'completion_status_counts': CompletionStatusCounts;
686
+ /**
687
+ * How many of those enrollments need attention: the learner never started, or they are still working through the course and their last recorded activity was at least 30 days ago. Learners who are passing or hold an unrevoked certificate aren\'t counted, nor are enrollments with hidden progress.
688
+ */
689
+ 'needs_attention_count': number;
690
+ /**
691
+ * This page of enrollments.
692
+ */
693
+ 'data': Array<LearnerProgress>;
694
+ }
695
+ /**
696
+ * One learner under the contract, with all of their active enrollments.
697
+ */
698
+ export interface LearnerWithEnrollments {
699
+ /**
700
+ * The learner\'s account ID. It stays the same if their email address changes.
701
+ */
702
+ 'learner_id': string;
703
+ /**
704
+ * The learner\'s email address. It may differ from the one they enrolled with.
705
+ */
706
+ 'email': string | null;
707
+ /**
708
+ * The learner\'s name, if they\'ve provided one.
709
+ */
710
+ 'full_name': string | null;
711
+ /**
712
+ * Every course the learner is enrolled in under the contract, including the ones that didn\'t match the filters.
713
+ */
714
+ 'enrollments': Array<LearnerEnrollment>;
715
+ }
716
+ /**
717
+ * The org envelope (``organization_id``, ``as_of``, ``total_count``, ``data``), paged by learner. ``total_count`` counts learners, not enrollments, and the envelope carries no other counts.
718
+ */
719
+ export interface LearnersResponse {
720
+ /**
721
+ * The organization\'s ID.
722
+ */
723
+ 'organization_id': string;
724
+ /**
725
+ * When the data was last updated. Empty before the first update.
726
+ */
727
+ 'as_of': string | null;
728
+ /**
729
+ * Learners with at least one enrollment that matches the filters, across all pages.
730
+ */
731
+ 'total_count': number;
732
+ /**
733
+ * This page of learners.
734
+ */
735
+ 'data': Array<LearnerWithEnrollments>;
736
+ }
737
+ export interface LocationInner {
738
+ }
739
+ /**
740
+ * mv_b2b_mit_admin_contract_health — grain: org x contract (MIT admin only). Floored like ``ContractUtilization``. ``health_status`` is computed in the view from ``b2b_contract_is_active``, ``seat_utilization_pct`` and ``b2b_contract_end_date``.
741
+ */
742
+ export interface MitAdminContractHealth {
743
+ /**
744
+ * Internal identifier for the organization.
745
+ */
746
+ 'organization_key': string;
747
+ /**
748
+ * The organization\'s name.
749
+ */
750
+ 'organization_name': string;
751
+ /**
752
+ * Internal identifier for the contract.
753
+ */
754
+ 'contract_pk': string;
755
+ /**
756
+ * The contract\'s ID in MITx Online.
757
+ */
758
+ 'contract_id': number;
759
+ /**
760
+ * The contract\'s name.
761
+ */
762
+ 'b2b_contract_name': string;
763
+ /**
764
+ * Whether the contract is currently active.
765
+ */
766
+ 'b2b_contract_is_active': boolean;
767
+ /**
768
+ * When the contract starts. Empty if no start date is set.
769
+ */
770
+ 'b2b_contract_start_date': string | null;
771
+ /**
772
+ * When the contract ends. Empty if it has no end date.
773
+ */
774
+ 'b2b_contract_end_date': string | null;
775
+ /**
776
+ * How many seats the contract includes. Empty or zero means unlimited.
777
+ */
778
+ 'seat_limit': number | null;
779
+ /**
780
+ * The contract\'s membership type. Empty if not set.
781
+ */
782
+ 'b2b_contract_membership_type': string | null;
783
+ /**
784
+ * Learners enrolled in at least one course under the contract. When too few learners are in the group, the whole row is withheld to avoid identifying them.
785
+ */
786
+ 'seats_consumed': number;
787
+ /**
788
+ * Learners on the contract whose enrollment is still active. Withheld when too few learners are in the group to report without identifying them.
789
+ */
790
+ 'active_learners': number | null;
791
+ /**
792
+ * Learners on the contract who earned a certificate that hasn\'t been revoked. Withheld when too few learners are in the group to report without identifying them.
793
+ */
794
+ 'certified_learners': number | null;
795
+ /**
796
+ * Percentage of the contract\'s seats in use. Empty when the contract has unlimited seats.
797
+ */
798
+ 'seat_utilization_pct': number | null;
799
+ /**
800
+ * Percentage of enrolled learners who earned a certificate. Withheld when the learner count it is based on is withheld.
801
+ */
802
+ 'completion_rate_pct': number | null;
803
+ /**
804
+ * Overall contract health: inactive (the contract isn\'t active), high_utilization (90% or more of seats in use), at_risk (under 25% of seats in use and the contract ends within 90 days), healthy (50% or more of seats in use), or early_stage (anything else).
805
+ */
806
+ 'health_status': string;
807
+ }
808
+ /**
809
+ * mv_b2b_monthly_engagement_trend — grain: org x year_month. Every aggregate here is floored through the cohort that contributes to it, which the view publishes alongside it (ol-data-platform PR #2520). ``contributing_learners`` is the primary cohort and gates the row. It counts every learner behind the month: active, enrolling or certified (ol-data-platform PR #2881). Every other learner count in the row is a subset of it. It is selected for the gate and excluded from the response. ``monthly_active_learners`` is not the gate, because activity is course work only. Enrolling or being issued a certificate does not make a learner active, so ``enrolling_learners`` and ``certified_learners`` are not subsets of it, and a month can have enough of either with too few active learners. Gating on it would withhold those figures for no privacy reason. It is a secondary count, nulled on its own terms. The active, enrolling and certified counts are ``uncontained``. None of them sits inside another, and their one container, the primary, is never returned, so a caller has nothing to subtract them from and the complement rule would suppress on a number nobody can see. No total is attributable to the primary. Each is a SUM contributed by only the learners who did that specific thing, and clearing the primary floor says nothing about whether that narrower cohort cleared it. A month with 40 contributing learners can carry a chatbot total from exactly one of them, which is why each total is ``derived`` from its own cohort. ``new_enrollments`` and ``certificates_earned`` are SUMs of per-learner-per-course-run markers, so they count *events*, not learners: one learner enrolling in six runs reads as ``new_enrollments == 6`` and would clear a floor of 5 on its own. Flooring them directly is therefore the wrong instrument — they are ``derived`` from ``enrolling_learners`` and ``certified_learners``, the distinct-learner counts they are actually attributable to, which do carry the floor. ``contributing_learners`` is Optional even though it is the primary — everywhere else the primary gates the row (below floor, the row is dropped whole, never nulled) rather than being nulled itself. The org grain is the exception: every cohort column is this endpoint\'s ``_FinerGrain.guarded_cohorts`` target, so a month whose contract-level breakdown hides anything gets its org-level learner counts blanked post hoc, after its own row gate already passed. See ``routers.organizations`` and ``ContractMonthlyEngagementTrend``.
810
+ */
811
+ export interface MonthlyEngagementTrend {
812
+ /**
813
+ * Internal identifier for the organization.
814
+ */
815
+ 'organization_key': string;
816
+ /**
817
+ * The organization\'s name.
818
+ */
819
+ 'organization_name': string;
820
+ /**
821
+ * The month, e.g. 2026-08.
822
+ */
823
+ 'activity_year_and_month': string;
824
+ /**
825
+ * Learners who did course work this month: watched a video, attempted a problem, posted in a discussion, used the chatbot or moved through course pages. Enrolling or earning a certificate alone doesn\'t count. Withheld when too few learners are in the group to report without identifying them.
826
+ */
827
+ 'monthly_active_learners': number | null;
828
+ /**
829
+ * Course enrollments made this month. A learner who enrolled in six courses counts six times. Withheld when the learner count it is based on is withheld.
830
+ */
831
+ 'new_enrollments': number | null;
832
+ /**
833
+ * Learners who enrolled in at least one course this month. Withheld when too few learners are in the group to report without identifying them.
834
+ */
835
+ 'enrolling_learners': number | null;
836
+ /**
837
+ * Certificates earned this month. A learner who earned two counts twice. Withheld when the learner count it is based on is withheld.
838
+ */
839
+ 'certificates_earned': number | null;
840
+ /**
841
+ * Learners who earned at least one certificate this month. Withheld when too few learners are in the group to report without identifying them.
842
+ */
843
+ 'certified_learners': number | null;
844
+ /**
845
+ * Videos watched this month, counting every view. Withheld when the learner count it is based on is withheld.
846
+ */
847
+ 'total_videos_watched': number | null;
848
+ /**
849
+ * Learners who watched at least one video this month. Withheld when too few learners are in the group to report without identifying them.
850
+ */
851
+ 'video_watchers': number | null;
852
+ /**
853
+ * Problem attempts this month, counting every attempt. Withheld when the learner count it is based on is withheld.
854
+ */
855
+ 'total_problems_attempted': number | null;
856
+ /**
857
+ * Learners who attempted at least one problem this month. Withheld when too few learners are in the group to report without identifying them.
858
+ */
859
+ 'problem_attempters': number | null;
860
+ /**
861
+ * Chatbot interactions this month. Withheld when the learner count it is based on is withheld.
862
+ */
863
+ 'total_chatbot_interactions': number | null;
864
+ /**
865
+ * Learners who used the chatbot this month. Withheld when too few learners are in the group to report without identifying them.
866
+ */
867
+ 'chatbot_users': number | null;
868
+ }
869
+ export interface OrgAnalyticsResponseContentEngagementDepth {
870
+ 'organization_id': string;
871
+ 'as_of': string | null;
872
+ 'total_count': number;
873
+ 'data': Array<ContentEngagementDepth>;
874
+ }
875
+ export interface OrgAnalyticsResponseContractContentEngagementDepth {
876
+ 'organization_id': string;
877
+ 'as_of': string | null;
878
+ 'total_count': number;
879
+ 'data': Array<ContractContentEngagementDepth>;
880
+ }
881
+ export interface OrgAnalyticsResponseContractMonthlyEngagementTrend {
882
+ 'organization_id': string;
883
+ 'as_of': string | null;
884
+ 'total_count': number;
885
+ 'data': Array<ContractMonthlyEngagementTrend>;
886
+ }
887
+ export interface OrgAnalyticsResponseContractNeedsAttention {
888
+ 'organization_id': string;
889
+ 'as_of': string | null;
890
+ 'total_count': number;
891
+ 'data': Array<ContractNeedsAttention>;
892
+ }
893
+ export interface OrgAnalyticsResponseContractUtilization {
894
+ 'organization_id': string;
895
+ 'as_of': string | null;
896
+ 'total_count': number;
897
+ 'data': Array<ContractUtilization>;
898
+ }
899
+ export interface OrgAnalyticsResponseEnrollmentCompletionFunnel {
900
+ 'organization_id': string;
901
+ 'as_of': string | null;
902
+ 'total_count': number;
903
+ 'data': Array<EnrollmentCompletionFunnel>;
904
+ }
905
+ export interface OrgAnalyticsResponseMonthlyEngagementTrend {
906
+ 'organization_id': string;
907
+ 'as_of': string | null;
908
+ 'total_count': number;
909
+ 'data': Array<MonthlyEngagementTrend>;
910
+ }
911
+ export interface OrgAnalyticsResponseProgramFunnel {
912
+ 'organization_id': string;
913
+ 'as_of': string | null;
914
+ 'total_count': number;
915
+ 'data': Array<ProgramFunnel>;
916
+ }
917
+ /**
918
+ * mv_b2b_program_funnel — grain: org x contract x program. ``total_courses`` counts courses, not learners, so it is not a cohort. ``program_course_completers`` approximates program completion: it counts a non-revoked certificate in any contract-covered course of the program, not a program-level certificate, pending a program-certificate fact table.
919
+ */
920
+ export interface ProgramFunnel {
921
+ /**
922
+ * Internal identifier for the organization.
923
+ */
924
+ 'organization_key': string;
925
+ /**
926
+ * The organization\'s name.
927
+ */
928
+ 'organization_name': string;
929
+ /**
930
+ * Internal identifier for the contract.
931
+ */
932
+ 'contract_pk': string;
933
+ /**
934
+ * The contract\'s ID in MITx Online.
935
+ */
936
+ 'contract_id': number;
937
+ /**
938
+ * The contract\'s name.
939
+ */
940
+ 'b2b_contract_name': string;
941
+ /**
942
+ * Internal identifier for the program.
943
+ */
944
+ 'program_pk': string;
945
+ /**
946
+ * The program\'s title.
947
+ */
948
+ 'program_title': string;
949
+ /**
950
+ * Courses in the program that the contract covers.
951
+ */
952
+ 'total_courses': number;
953
+ /**
954
+ * Learners enrolled in at least one of the program\'s courses under the contract. When too few learners are in the group, the whole row is withheld to avoid identifying them.
955
+ */
956
+ 'enrolled_in_contract_courses': number;
957
+ /**
958
+ * Of those learners, how many enrolled in the program itself rather than directly in one of its courses. Withheld when too few learners are in the group to report without identifying them.
959
+ */
960
+ 'enrolled_via_program': number | null;
961
+ /**
962
+ * Learners who earned a certificate in at least one of the program\'s courses under the contract. This isn\'t the same as completing the whole program. Withheld when too few learners are in the group to report without identifying them.
963
+ */
964
+ 'program_course_completers': number | null;
965
+ }
966
+ export declare const SortKey: {
967
+ readonly FullName: "full_name";
968
+ readonly Email: "email";
969
+ readonly EnrolledOn: "enrolled_on";
970
+ readonly CourserunReadableId: "courserun_readable_id";
971
+ };
972
+ export type SortKey = typeof SortKey[keyof typeof SortKey];
973
+ export interface ValidationError {
974
+ 'loc': Array<LocationInner>;
975
+ 'msg': string;
976
+ 'type': string;
977
+ 'input'?: any;
978
+ 'ctx'?: object;
979
+ }
980
+ /**
981
+ * AdminApi - axios parameter creator
982
+ */
983
+ export declare const AdminApiAxiosParamCreator: (configuration?: Configuration) => {
984
+ /**
985
+ *
986
+ * @summary Contract Health
987
+ * @param {number} [limit]
988
+ * @param {number} [offset]
989
+ * @param {*} [options] Override http request option.
990
+ * @throws {RequiredError}
991
+ */
992
+ adminContractHealthRetrieve: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
993
+ };
994
+ /**
995
+ * AdminApi - functional programming interface
996
+ */
997
+ export declare const AdminApiFp: (configuration?: Configuration) => {
998
+ /**
999
+ *
1000
+ * @summary Contract Health
1001
+ * @param {number} [limit]
1002
+ * @param {number} [offset]
1003
+ * @param {*} [options] Override http request option.
1004
+ * @throws {RequiredError}
1005
+ */
1006
+ adminContractHealthRetrieve(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsResponseMitAdminContractHealth>>;
1007
+ };
1008
+ /**
1009
+ * AdminApi - factory interface
1010
+ */
1011
+ export declare const AdminApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1012
+ /**
1013
+ *
1014
+ * @summary Contract Health
1015
+ * @param {AdminApiAdminContractHealthRetrieveRequest} requestParameters Request parameters.
1016
+ * @param {*} [options] Override http request option.
1017
+ * @throws {RequiredError}
1018
+ */
1019
+ adminContractHealthRetrieve(requestParameters?: AdminApiAdminContractHealthRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsResponseMitAdminContractHealth>;
1020
+ };
1021
+ /**
1022
+ * Request parameters for adminContractHealthRetrieve operation in AdminApi.
1023
+ */
1024
+ export interface AdminApiAdminContractHealthRetrieveRequest {
1025
+ readonly limit?: number;
1026
+ readonly offset?: number;
1027
+ }
1028
+ /**
1029
+ * AdminApi - object-oriented interface
1030
+ */
1031
+ export declare class AdminApi extends BaseAPI {
1032
+ /**
1033
+ *
1034
+ * @summary Contract Health
1035
+ * @param {AdminApiAdminContractHealthRetrieveRequest} requestParameters Request parameters.
1036
+ * @param {*} [options] Override http request option.
1037
+ * @throws {RequiredError}
1038
+ */
1039
+ adminContractHealthRetrieve(requestParameters?: AdminApiAdminContractHealthRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsResponseMitAdminContractHealth, any, {}, any>>;
1040
+ }
1041
+ /**
1042
+ * ContractsApi - axios parameter creator
1043
+ */
1044
+ export declare const ContractsApiAxiosParamCreator: (configuration?: Configuration) => {
1045
+ /**
1046
+ *
1047
+ * @summary Content Engagement
1048
+ * @param {string} organization_id
1049
+ * @param {number} contract_id
1050
+ * @param {number} [limit]
1051
+ * @param {number} [offset]
1052
+ * @param {*} [options] Override http request option.
1053
+ * @throws {RequiredError}
1054
+ */
1055
+ contractsContentEngagementRetrieve: (organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1056
+ /**
1057
+ *
1058
+ * @summary Contract Utilization
1059
+ * @param {string} organization_id
1060
+ * @param {number} contract_id
1061
+ * @param {number} [limit]
1062
+ * @param {number} [offset]
1063
+ * @param {*} [options] Override http request option.
1064
+ * @throws {RequiredError}
1065
+ */
1066
+ contractsContractUtilizationRetrieve: (organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1067
+ /**
1068
+ *
1069
+ * @summary Engagement Trend
1070
+ * @param {string} organization_id
1071
+ * @param {number} contract_id
1072
+ * @param {number} [limit]
1073
+ * @param {number} [offset]
1074
+ * @param {*} [options] Override http request option.
1075
+ * @throws {RequiredError}
1076
+ */
1077
+ contractsEngagementTrendRetrieve: (organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1078
+ /**
1079
+ *
1080
+ * @summary Enrollment Funnel
1081
+ * @param {string} organization_id
1082
+ * @param {number} contract_id
1083
+ * @param {number} [limit]
1084
+ * @param {number} [offset]
1085
+ * @param {*} [options] Override http request option.
1086
+ * @throws {RequiredError}
1087
+ */
1088
+ contractsEnrollmentFunnelRetrieve: (organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1089
+ /**
1090
+ *
1091
+ * @summary Program Funnel
1092
+ * @param {string} organization_id
1093
+ * @param {number} contract_id
1094
+ * @param {number} [limit]
1095
+ * @param {number} [offset]
1096
+ * @param {*} [options] Override http request option.
1097
+ * @throws {RequiredError}
1098
+ */
1099
+ contractsProgramFunnelRetrieve: (organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1100
+ };
1101
+ /**
1102
+ * ContractsApi - functional programming interface
1103
+ */
1104
+ export declare const ContractsApiFp: (configuration?: Configuration) => {
1105
+ /**
1106
+ *
1107
+ * @summary Content Engagement
1108
+ * @param {string} organization_id
1109
+ * @param {number} contract_id
1110
+ * @param {number} [limit]
1111
+ * @param {number} [offset]
1112
+ * @param {*} [options] Override http request option.
1113
+ * @throws {RequiredError}
1114
+ */
1115
+ contractsContentEngagementRetrieve(organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseContractContentEngagementDepth>>;
1116
+ /**
1117
+ *
1118
+ * @summary Contract Utilization
1119
+ * @param {string} organization_id
1120
+ * @param {number} contract_id
1121
+ * @param {number} [limit]
1122
+ * @param {number} [offset]
1123
+ * @param {*} [options] Override http request option.
1124
+ * @throws {RequiredError}
1125
+ */
1126
+ contractsContractUtilizationRetrieve(organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseContractUtilization>>;
1127
+ /**
1128
+ *
1129
+ * @summary Engagement Trend
1130
+ * @param {string} organization_id
1131
+ * @param {number} contract_id
1132
+ * @param {number} [limit]
1133
+ * @param {number} [offset]
1134
+ * @param {*} [options] Override http request option.
1135
+ * @throws {RequiredError}
1136
+ */
1137
+ contractsEngagementTrendRetrieve(organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseContractMonthlyEngagementTrend>>;
1138
+ /**
1139
+ *
1140
+ * @summary Enrollment Funnel
1141
+ * @param {string} organization_id
1142
+ * @param {number} contract_id
1143
+ * @param {number} [limit]
1144
+ * @param {number} [offset]
1145
+ * @param {*} [options] Override http request option.
1146
+ * @throws {RequiredError}
1147
+ */
1148
+ contractsEnrollmentFunnelRetrieve(organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseEnrollmentCompletionFunnel>>;
1149
+ /**
1150
+ *
1151
+ * @summary Program Funnel
1152
+ * @param {string} organization_id
1153
+ * @param {number} contract_id
1154
+ * @param {number} [limit]
1155
+ * @param {number} [offset]
1156
+ * @param {*} [options] Override http request option.
1157
+ * @throws {RequiredError}
1158
+ */
1159
+ contractsProgramFunnelRetrieve(organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseProgramFunnel>>;
1160
+ };
1161
+ /**
1162
+ * ContractsApi - factory interface
1163
+ */
1164
+ export declare const ContractsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1165
+ /**
1166
+ *
1167
+ * @summary Content Engagement
1168
+ * @param {ContractsApiContractsContentEngagementRetrieveRequest} requestParameters Request parameters.
1169
+ * @param {*} [options] Override http request option.
1170
+ * @throws {RequiredError}
1171
+ */
1172
+ contractsContentEngagementRetrieve(requestParameters: ContractsApiContractsContentEngagementRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseContractContentEngagementDepth>;
1173
+ /**
1174
+ *
1175
+ * @summary Contract Utilization
1176
+ * @param {ContractsApiContractsContractUtilizationRetrieveRequest} requestParameters Request parameters.
1177
+ * @param {*} [options] Override http request option.
1178
+ * @throws {RequiredError}
1179
+ */
1180
+ contractsContractUtilizationRetrieve(requestParameters: ContractsApiContractsContractUtilizationRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseContractUtilization>;
1181
+ /**
1182
+ *
1183
+ * @summary Engagement Trend
1184
+ * @param {ContractsApiContractsEngagementTrendRetrieveRequest} requestParameters Request parameters.
1185
+ * @param {*} [options] Override http request option.
1186
+ * @throws {RequiredError}
1187
+ */
1188
+ contractsEngagementTrendRetrieve(requestParameters: ContractsApiContractsEngagementTrendRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseContractMonthlyEngagementTrend>;
1189
+ /**
1190
+ *
1191
+ * @summary Enrollment Funnel
1192
+ * @param {ContractsApiContractsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
1193
+ * @param {*} [options] Override http request option.
1194
+ * @throws {RequiredError}
1195
+ */
1196
+ contractsEnrollmentFunnelRetrieve(requestParameters: ContractsApiContractsEnrollmentFunnelRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseEnrollmentCompletionFunnel>;
1197
+ /**
1198
+ *
1199
+ * @summary Program Funnel
1200
+ * @param {ContractsApiContractsProgramFunnelRetrieveRequest} requestParameters Request parameters.
1201
+ * @param {*} [options] Override http request option.
1202
+ * @throws {RequiredError}
1203
+ */
1204
+ contractsProgramFunnelRetrieve(requestParameters: ContractsApiContractsProgramFunnelRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseProgramFunnel>;
1205
+ };
1206
+ /**
1207
+ * Request parameters for contractsContentEngagementRetrieve operation in ContractsApi.
1208
+ */
1209
+ export interface ContractsApiContractsContentEngagementRetrieveRequest {
1210
+ readonly organization_id: string;
1211
+ readonly contract_id: number;
1212
+ readonly limit?: number;
1213
+ readonly offset?: number;
1214
+ }
1215
+ /**
1216
+ * Request parameters for contractsContractUtilizationRetrieve operation in ContractsApi.
1217
+ */
1218
+ export interface ContractsApiContractsContractUtilizationRetrieveRequest {
1219
+ readonly organization_id: string;
1220
+ readonly contract_id: number;
1221
+ readonly limit?: number;
1222
+ readonly offset?: number;
1223
+ }
1224
+ /**
1225
+ * Request parameters for contractsEngagementTrendRetrieve operation in ContractsApi.
1226
+ */
1227
+ export interface ContractsApiContractsEngagementTrendRetrieveRequest {
1228
+ readonly organization_id: string;
1229
+ readonly contract_id: number;
1230
+ readonly limit?: number;
1231
+ readonly offset?: number;
1232
+ }
1233
+ /**
1234
+ * Request parameters for contractsEnrollmentFunnelRetrieve operation in ContractsApi.
1235
+ */
1236
+ export interface ContractsApiContractsEnrollmentFunnelRetrieveRequest {
1237
+ readonly organization_id: string;
1238
+ readonly contract_id: number;
1239
+ readonly limit?: number;
1240
+ readonly offset?: number;
1241
+ }
1242
+ /**
1243
+ * Request parameters for contractsProgramFunnelRetrieve operation in ContractsApi.
1244
+ */
1245
+ export interface ContractsApiContractsProgramFunnelRetrieveRequest {
1246
+ readonly organization_id: string;
1247
+ readonly contract_id: number;
1248
+ readonly limit?: number;
1249
+ readonly offset?: number;
1250
+ }
1251
+ /**
1252
+ * ContractsApi - object-oriented interface
1253
+ */
1254
+ export declare class ContractsApi extends BaseAPI {
1255
+ /**
1256
+ *
1257
+ * @summary Content Engagement
1258
+ * @param {ContractsApiContractsContentEngagementRetrieveRequest} requestParameters Request parameters.
1259
+ * @param {*} [options] Override http request option.
1260
+ * @throws {RequiredError}
1261
+ */
1262
+ contractsContentEngagementRetrieve(requestParameters: ContractsApiContractsContentEngagementRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseContractContentEngagementDepth, any, {}, any>>;
1263
+ /**
1264
+ *
1265
+ * @summary Contract Utilization
1266
+ * @param {ContractsApiContractsContractUtilizationRetrieveRequest} requestParameters Request parameters.
1267
+ * @param {*} [options] Override http request option.
1268
+ * @throws {RequiredError}
1269
+ */
1270
+ contractsContractUtilizationRetrieve(requestParameters: ContractsApiContractsContractUtilizationRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseContractUtilization, any, {}, any>>;
1271
+ /**
1272
+ *
1273
+ * @summary Engagement Trend
1274
+ * @param {ContractsApiContractsEngagementTrendRetrieveRequest} requestParameters Request parameters.
1275
+ * @param {*} [options] Override http request option.
1276
+ * @throws {RequiredError}
1277
+ */
1278
+ contractsEngagementTrendRetrieve(requestParameters: ContractsApiContractsEngagementTrendRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseContractMonthlyEngagementTrend, any, {}, any>>;
1279
+ /**
1280
+ *
1281
+ * @summary Enrollment Funnel
1282
+ * @param {ContractsApiContractsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
1283
+ * @param {*} [options] Override http request option.
1284
+ * @throws {RequiredError}
1285
+ */
1286
+ contractsEnrollmentFunnelRetrieve(requestParameters: ContractsApiContractsEnrollmentFunnelRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseEnrollmentCompletionFunnel, any, {}, any>>;
1287
+ /**
1288
+ *
1289
+ * @summary Program Funnel
1290
+ * @param {ContractsApiContractsProgramFunnelRetrieveRequest} requestParameters Request parameters.
1291
+ * @param {*} [options] Override http request option.
1292
+ * @throws {RequiredError}
1293
+ */
1294
+ contractsProgramFunnelRetrieve(requestParameters: ContractsApiContractsProgramFunnelRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseProgramFunnel, any, {}, any>>;
1295
+ }
1296
+ /**
1297
+ * LearnersApi - axios parameter creator
1298
+ */
1299
+ export declare const LearnersApiAxiosParamCreator: (configuration?: Configuration) => {
1300
+ /**
1301
+ *
1302
+ * @summary Course runs under the contract, for the learner-progress module filter
1303
+ * @param {string} organization_id
1304
+ * @param {number} contract_id
1305
+ * @param {number} [limit]
1306
+ * @param {number} [offset]
1307
+ * @param {*} [options] Override http request option.
1308
+ * @throws {RequiredError}
1309
+ */
1310
+ learnersCourseRunsRetrieve: (organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1311
+ /**
1312
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
1313
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
1314
+ * @param {string} organization_id
1315
+ * @param {number} contract_id
1316
+ * @param {string | null} [search] Case-insensitive match on email or name.
1317
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
1318
+ * @param {Array<string>} [courserun_readable_id] Repeat for several modules; they OR together and AND with the other filters. At most 50.
1319
+ * @param {boolean | null} [needs_attention] Keep only learners with an enrollment that needs attention, or with one that doesn\&#39;t. Rows with withheld outcomes match neither, so omit this to see them.
1320
+ * @param {number} [limit]
1321
+ * @param {number} [offset]
1322
+ * @param {*} [options] Override http request option.
1323
+ * @throws {RequiredError}
1324
+ */
1325
+ learnersList: (organization_id: string, contract_id: number, search?: string | null, completion_status?: Array<CompletionStatusFilter>, courserun_readable_id?: Array<string>, needs_attention?: boolean | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1326
+ /**
1327
+ *
1328
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
1329
+ * @param {string} organization_id
1330
+ * @param {number} contract_id
1331
+ * @param {string | null} [search] Case-insensitive match on email or name.
1332
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
1333
+ * @param {string | null} [courserun_readable_id] Exact match. Narrows to one course run, e.g. the module filter.
1334
+ * @param {boolean | null} [needs_attention] Keep only the learners who need attention, or only those who don\&#39;t. Cuts the same rows &#x60;needs_attention_count&#x60; counts. Rows with withheld outcomes match neither, so omit this to see them.
1335
+ * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded).
1336
+ * @param {SortKey} [sort]
1337
+ * @param {boolean} [descending]
1338
+ * @param {number} [limit]
1339
+ * @param {number} [offset]
1340
+ * @param {*} [options] Override http request option.
1341
+ * @throws {RequiredError}
1342
+ */
1343
+ learnersProgressRetrieve: (organization_id: string, contract_id: number, search?: string | null, completion_status?: Array<CompletionStatusFilter>, courserun_readable_id?: string | null, needs_attention?: boolean | null, include_inactive?: boolean, sort?: SortKey, descending?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1344
+ };
1345
+ /**
1346
+ * LearnersApi - functional programming interface
1347
+ */
1348
+ export declare const LearnersApiFp: (configuration?: Configuration) => {
1349
+ /**
1350
+ *
1351
+ * @summary Course runs under the contract, for the learner-progress module filter
1352
+ * @param {string} organization_id
1353
+ * @param {number} contract_id
1354
+ * @param {number} [limit]
1355
+ * @param {number} [offset]
1356
+ * @param {*} [options] Override http request option.
1357
+ * @throws {RequiredError}
1358
+ */
1359
+ learnersCourseRunsRetrieve(organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CourseRunsResponse>>;
1360
+ /**
1361
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
1362
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
1363
+ * @param {string} organization_id
1364
+ * @param {number} contract_id
1365
+ * @param {string | null} [search] Case-insensitive match on email or name.
1366
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
1367
+ * @param {Array<string>} [courserun_readable_id] Repeat for several modules; they OR together and AND with the other filters. At most 50.
1368
+ * @param {boolean | null} [needs_attention] Keep only learners with an enrollment that needs attention, or with one that doesn\&#39;t. Rows with withheld outcomes match neither, so omit this to see them.
1369
+ * @param {number} [limit]
1370
+ * @param {number} [offset]
1371
+ * @param {*} [options] Override http request option.
1372
+ * @throws {RequiredError}
1373
+ */
1374
+ learnersList(organization_id: string, contract_id: number, search?: string | null, completion_status?: Array<CompletionStatusFilter>, courserun_readable_id?: Array<string>, needs_attention?: boolean | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LearnersResponse>>;
1375
+ /**
1376
+ *
1377
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
1378
+ * @param {string} organization_id
1379
+ * @param {number} contract_id
1380
+ * @param {string | null} [search] Case-insensitive match on email or name.
1381
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
1382
+ * @param {string | null} [courserun_readable_id] Exact match. Narrows to one course run, e.g. the module filter.
1383
+ * @param {boolean | null} [needs_attention] Keep only the learners who need attention, or only those who don\&#39;t. Cuts the same rows &#x60;needs_attention_count&#x60; counts. Rows with withheld outcomes match neither, so omit this to see them.
1384
+ * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded).
1385
+ * @param {SortKey} [sort]
1386
+ * @param {boolean} [descending]
1387
+ * @param {number} [limit]
1388
+ * @param {number} [offset]
1389
+ * @param {*} [options] Override http request option.
1390
+ * @throws {RequiredError}
1391
+ */
1392
+ learnersProgressRetrieve(organization_id: string, contract_id: number, search?: string | null, completion_status?: Array<CompletionStatusFilter>, courserun_readable_id?: string | null, needs_attention?: boolean | null, include_inactive?: boolean, sort?: SortKey, descending?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LearnerProgressResponse>>;
1393
+ };
1394
+ /**
1395
+ * LearnersApi - factory interface
1396
+ */
1397
+ export declare const LearnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1398
+ /**
1399
+ *
1400
+ * @summary Course runs under the contract, for the learner-progress module filter
1401
+ * @param {LearnersApiLearnersCourseRunsRetrieveRequest} requestParameters Request parameters.
1402
+ * @param {*} [options] Override http request option.
1403
+ * @throws {RequiredError}
1404
+ */
1405
+ learnersCourseRunsRetrieve(requestParameters: LearnersApiLearnersCourseRunsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<CourseRunsResponse>;
1406
+ /**
1407
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
1408
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
1409
+ * @param {LearnersApiLearnersListRequest} requestParameters Request parameters.
1410
+ * @param {*} [options] Override http request option.
1411
+ * @throws {RequiredError}
1412
+ */
1413
+ learnersList(requestParameters: LearnersApiLearnersListRequest, options?: RawAxiosRequestConfig): AxiosPromise<LearnersResponse>;
1414
+ /**
1415
+ *
1416
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
1417
+ * @param {LearnersApiLearnersProgressRetrieveRequest} requestParameters Request parameters.
1418
+ * @param {*} [options] Override http request option.
1419
+ * @throws {RequiredError}
1420
+ */
1421
+ learnersProgressRetrieve(requestParameters: LearnersApiLearnersProgressRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<LearnerProgressResponse>;
1422
+ };
1423
+ /**
1424
+ * Request parameters for learnersCourseRunsRetrieve operation in LearnersApi.
1425
+ */
1426
+ export interface LearnersApiLearnersCourseRunsRetrieveRequest {
1427
+ readonly organization_id: string;
1428
+ readonly contract_id: number;
1429
+ readonly limit?: number;
1430
+ readonly offset?: number;
1431
+ }
1432
+ /**
1433
+ * Request parameters for learnersList operation in LearnersApi.
1434
+ */
1435
+ export interface LearnersApiLearnersListRequest {
1436
+ readonly organization_id: string;
1437
+ readonly contract_id: number;
1438
+ /**
1439
+ * Case-insensitive match on email or name.
1440
+ */
1441
+ readonly search?: string | null;
1442
+ /**
1443
+ * Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
1444
+ */
1445
+ readonly completion_status?: Array<CompletionStatusFilter>;
1446
+ /**
1447
+ * Repeat for several modules; they OR together and AND with the other filters. At most 50.
1448
+ */
1449
+ readonly courserun_readable_id?: Array<string>;
1450
+ /**
1451
+ * Keep only learners with an enrollment that needs attention, or with one that doesn\&#39;t. Rows with withheld outcomes match neither, so omit this to see them.
1452
+ */
1453
+ readonly needs_attention?: boolean | null;
1454
+ readonly limit?: number;
1455
+ readonly offset?: number;
1456
+ }
1457
+ /**
1458
+ * Request parameters for learnersProgressRetrieve operation in LearnersApi.
1459
+ */
1460
+ export interface LearnersApiLearnersProgressRetrieveRequest {
1461
+ readonly organization_id: string;
1462
+ readonly contract_id: number;
1463
+ /**
1464
+ * Case-insensitive match on email or name.
1465
+ */
1466
+ readonly search?: string | null;
1467
+ /**
1468
+ * Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
1469
+ */
1470
+ readonly completion_status?: Array<CompletionStatusFilter>;
1471
+ /**
1472
+ * Exact match. Narrows to one course run, e.g. the module filter.
1473
+ */
1474
+ readonly courserun_readable_id?: string | null;
1475
+ /**
1476
+ * Keep only the learners who need attention, or only those who don\&#39;t. Cuts the same rows &#x60;needs_attention_count&#x60; counts. Rows with withheld outcomes match neither, so omit this to see them.
1477
+ */
1478
+ readonly needs_attention?: boolean | null;
1479
+ /**
1480
+ * Include deactivated enrollments (unenrolled, refunded).
1481
+ */
1482
+ readonly include_inactive?: boolean;
1483
+ readonly sort?: SortKey;
1484
+ readonly descending?: boolean;
1485
+ readonly limit?: number;
1486
+ readonly offset?: number;
1487
+ }
1488
+ /**
1489
+ * LearnersApi - object-oriented interface
1490
+ */
1491
+ export declare class LearnersApi extends BaseAPI {
1492
+ /**
1493
+ *
1494
+ * @summary Course runs under the contract, for the learner-progress module filter
1495
+ * @param {LearnersApiLearnersCourseRunsRetrieveRequest} requestParameters Request parameters.
1496
+ * @param {*} [options] Override http request option.
1497
+ * @throws {RequiredError}
1498
+ */
1499
+ learnersCourseRunsRetrieve(requestParameters: LearnersApiLearnersCourseRunsRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CourseRunsResponse, any, {}, any>>;
1500
+ /**
1501
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
1502
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
1503
+ * @param {LearnersApiLearnersListRequest} requestParameters Request parameters.
1504
+ * @param {*} [options] Override http request option.
1505
+ * @throws {RequiredError}
1506
+ */
1507
+ learnersList(requestParameters: LearnersApiLearnersListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LearnersResponse, any, {}, any>>;
1508
+ /**
1509
+ *
1510
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
1511
+ * @param {LearnersApiLearnersProgressRetrieveRequest} requestParameters Request parameters.
1512
+ * @param {*} [options] Override http request option.
1513
+ * @throws {RequiredError}
1514
+ */
1515
+ learnersProgressRetrieve(requestParameters: LearnersApiLearnersProgressRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LearnerProgressResponse, any, {}, any>>;
1516
+ }
1517
+ /**
1518
+ * NeedsAttentionApi - axios parameter creator
1519
+ */
1520
+ export declare const NeedsAttentionApiAxiosParamCreator: (configuration?: Configuration) => {
1521
+ /**
1522
+ *
1523
+ * @summary Learners who may need a nudge, counted once each, per contract
1524
+ * @param {string} organization_id
1525
+ * @param {number} contract_id
1526
+ * @param {number} [limit]
1527
+ * @param {number} [offset]
1528
+ * @param {*} [options] Override http request option.
1529
+ * @throws {RequiredError}
1530
+ */
1531
+ contractsNeedsAttentionRetrieve: (organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1532
+ /**
1533
+ *
1534
+ * @summary Learners who may need a nudge, counted once each, per contract
1535
+ * @param {string} organization_id
1536
+ * @param {number} [limit]
1537
+ * @param {number} [offset]
1538
+ * @param {*} [options] Override http request option.
1539
+ * @throws {RequiredError}
1540
+ */
1541
+ organizationsNeedsAttentionRetrieve: (organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1542
+ };
1543
+ /**
1544
+ * NeedsAttentionApi - functional programming interface
1545
+ */
1546
+ export declare const NeedsAttentionApiFp: (configuration?: Configuration) => {
1547
+ /**
1548
+ *
1549
+ * @summary Learners who may need a nudge, counted once each, per contract
1550
+ * @param {string} organization_id
1551
+ * @param {number} contract_id
1552
+ * @param {number} [limit]
1553
+ * @param {number} [offset]
1554
+ * @param {*} [options] Override http request option.
1555
+ * @throws {RequiredError}
1556
+ */
1557
+ contractsNeedsAttentionRetrieve(organization_id: string, contract_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseContractNeedsAttention>>;
1558
+ /**
1559
+ *
1560
+ * @summary Learners who may need a nudge, counted once each, per contract
1561
+ * @param {string} organization_id
1562
+ * @param {number} [limit]
1563
+ * @param {number} [offset]
1564
+ * @param {*} [options] Override http request option.
1565
+ * @throws {RequiredError}
1566
+ */
1567
+ organizationsNeedsAttentionRetrieve(organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseContractNeedsAttention>>;
1568
+ };
1569
+ /**
1570
+ * NeedsAttentionApi - factory interface
1571
+ */
1572
+ export declare const NeedsAttentionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1573
+ /**
1574
+ *
1575
+ * @summary Learners who may need a nudge, counted once each, per contract
1576
+ * @param {NeedsAttentionApiContractsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1577
+ * @param {*} [options] Override http request option.
1578
+ * @throws {RequiredError}
1579
+ */
1580
+ contractsNeedsAttentionRetrieve(requestParameters: NeedsAttentionApiContractsNeedsAttentionRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseContractNeedsAttention>;
1581
+ /**
1582
+ *
1583
+ * @summary Learners who may need a nudge, counted once each, per contract
1584
+ * @param {NeedsAttentionApiOrganizationsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1585
+ * @param {*} [options] Override http request option.
1586
+ * @throws {RequiredError}
1587
+ */
1588
+ organizationsNeedsAttentionRetrieve(requestParameters: NeedsAttentionApiOrganizationsNeedsAttentionRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseContractNeedsAttention>;
1589
+ };
1590
+ /**
1591
+ * Request parameters for contractsNeedsAttentionRetrieve operation in NeedsAttentionApi.
1592
+ */
1593
+ export interface NeedsAttentionApiContractsNeedsAttentionRetrieveRequest {
1594
+ readonly organization_id: string;
1595
+ readonly contract_id: number;
1596
+ readonly limit?: number;
1597
+ readonly offset?: number;
1598
+ }
1599
+ /**
1600
+ * Request parameters for organizationsNeedsAttentionRetrieve operation in NeedsAttentionApi.
1601
+ */
1602
+ export interface NeedsAttentionApiOrganizationsNeedsAttentionRetrieveRequest {
1603
+ readonly organization_id: string;
1604
+ readonly limit?: number;
1605
+ readonly offset?: number;
1606
+ }
1607
+ /**
1608
+ * NeedsAttentionApi - object-oriented interface
1609
+ */
1610
+ export declare class NeedsAttentionApi extends BaseAPI {
1611
+ /**
1612
+ *
1613
+ * @summary Learners who may need a nudge, counted once each, per contract
1614
+ * @param {NeedsAttentionApiContractsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1615
+ * @param {*} [options] Override http request option.
1616
+ * @throws {RequiredError}
1617
+ */
1618
+ contractsNeedsAttentionRetrieve(requestParameters: NeedsAttentionApiContractsNeedsAttentionRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseContractNeedsAttention, any, {}, any>>;
1619
+ /**
1620
+ *
1621
+ * @summary Learners who may need a nudge, counted once each, per contract
1622
+ * @param {NeedsAttentionApiOrganizationsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1623
+ * @param {*} [options] Override http request option.
1624
+ * @throws {RequiredError}
1625
+ */
1626
+ organizationsNeedsAttentionRetrieve(requestParameters: NeedsAttentionApiOrganizationsNeedsAttentionRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseContractNeedsAttention, any, {}, any>>;
1627
+ }
1628
+ /**
1629
+ * OrganizationsApi - axios parameter creator
1630
+ */
1631
+ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
1632
+ /**
1633
+ *
1634
+ * @summary Content Engagement
1635
+ * @param {string} organization_id
1636
+ * @param {number} [limit]
1637
+ * @param {number} [offset]
1638
+ * @param {*} [options] Override http request option.
1639
+ * @throws {RequiredError}
1640
+ */
1641
+ organizationsContentEngagementRetrieve: (organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1642
+ /**
1643
+ *
1644
+ * @summary Contract Utilization
1645
+ * @param {string} organization_id
1646
+ * @param {number} [limit]
1647
+ * @param {number} [offset]
1648
+ * @param {*} [options] Override http request option.
1649
+ * @throws {RequiredError}
1650
+ */
1651
+ organizationsContractUtilizationRetrieve: (organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1652
+ /**
1653
+ *
1654
+ * @summary Engagement Trend
1655
+ * @param {string} organization_id
1656
+ * @param {number} [limit]
1657
+ * @param {number} [offset]
1658
+ * @param {*} [options] Override http request option.
1659
+ * @throws {RequiredError}
1660
+ */
1661
+ organizationsEngagementTrendRetrieve: (organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1662
+ /**
1663
+ *
1664
+ * @summary Enrollment Funnel
1665
+ * @param {string} organization_id
1666
+ * @param {number} [limit]
1667
+ * @param {number} [offset]
1668
+ * @param {*} [options] Override http request option.
1669
+ * @throws {RequiredError}
1670
+ */
1671
+ organizationsEnrollmentFunnelRetrieve: (organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1672
+ /**
1673
+ *
1674
+ * @summary Program Funnel
1675
+ * @param {string} organization_id
1676
+ * @param {number} [limit]
1677
+ * @param {number} [offset]
1678
+ * @param {*} [options] Override http request option.
1679
+ * @throws {RequiredError}
1680
+ */
1681
+ organizationsProgramFunnelRetrieve: (organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1682
+ };
1683
+ /**
1684
+ * OrganizationsApi - functional programming interface
1685
+ */
1686
+ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
1687
+ /**
1688
+ *
1689
+ * @summary Content Engagement
1690
+ * @param {string} organization_id
1691
+ * @param {number} [limit]
1692
+ * @param {number} [offset]
1693
+ * @param {*} [options] Override http request option.
1694
+ * @throws {RequiredError}
1695
+ */
1696
+ organizationsContentEngagementRetrieve(organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseContentEngagementDepth>>;
1697
+ /**
1698
+ *
1699
+ * @summary Contract Utilization
1700
+ * @param {string} organization_id
1701
+ * @param {number} [limit]
1702
+ * @param {number} [offset]
1703
+ * @param {*} [options] Override http request option.
1704
+ * @throws {RequiredError}
1705
+ */
1706
+ organizationsContractUtilizationRetrieve(organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseContractUtilization>>;
1707
+ /**
1708
+ *
1709
+ * @summary Engagement Trend
1710
+ * @param {string} organization_id
1711
+ * @param {number} [limit]
1712
+ * @param {number} [offset]
1713
+ * @param {*} [options] Override http request option.
1714
+ * @throws {RequiredError}
1715
+ */
1716
+ organizationsEngagementTrendRetrieve(organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseMonthlyEngagementTrend>>;
1717
+ /**
1718
+ *
1719
+ * @summary Enrollment Funnel
1720
+ * @param {string} organization_id
1721
+ * @param {number} [limit]
1722
+ * @param {number} [offset]
1723
+ * @param {*} [options] Override http request option.
1724
+ * @throws {RequiredError}
1725
+ */
1726
+ organizationsEnrollmentFunnelRetrieve(organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseEnrollmentCompletionFunnel>>;
1727
+ /**
1728
+ *
1729
+ * @summary Program Funnel
1730
+ * @param {string} organization_id
1731
+ * @param {number} [limit]
1732
+ * @param {number} [offset]
1733
+ * @param {*} [options] Override http request option.
1734
+ * @throws {RequiredError}
1735
+ */
1736
+ organizationsProgramFunnelRetrieve(organization_id: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgAnalyticsResponseProgramFunnel>>;
1737
+ };
1738
+ /**
1739
+ * OrganizationsApi - factory interface
1740
+ */
1741
+ export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1742
+ /**
1743
+ *
1744
+ * @summary Content Engagement
1745
+ * @param {OrganizationsApiOrganizationsContentEngagementRetrieveRequest} requestParameters Request parameters.
1746
+ * @param {*} [options] Override http request option.
1747
+ * @throws {RequiredError}
1748
+ */
1749
+ organizationsContentEngagementRetrieve(requestParameters: OrganizationsApiOrganizationsContentEngagementRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseContentEngagementDepth>;
1750
+ /**
1751
+ *
1752
+ * @summary Contract Utilization
1753
+ * @param {OrganizationsApiOrganizationsContractUtilizationRetrieveRequest} requestParameters Request parameters.
1754
+ * @param {*} [options] Override http request option.
1755
+ * @throws {RequiredError}
1756
+ */
1757
+ organizationsContractUtilizationRetrieve(requestParameters: OrganizationsApiOrganizationsContractUtilizationRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseContractUtilization>;
1758
+ /**
1759
+ *
1760
+ * @summary Engagement Trend
1761
+ * @param {OrganizationsApiOrganizationsEngagementTrendRetrieveRequest} requestParameters Request parameters.
1762
+ * @param {*} [options] Override http request option.
1763
+ * @throws {RequiredError}
1764
+ */
1765
+ organizationsEngagementTrendRetrieve(requestParameters: OrganizationsApiOrganizationsEngagementTrendRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseMonthlyEngagementTrend>;
1766
+ /**
1767
+ *
1768
+ * @summary Enrollment Funnel
1769
+ * @param {OrganizationsApiOrganizationsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
1770
+ * @param {*} [options] Override http request option.
1771
+ * @throws {RequiredError}
1772
+ */
1773
+ organizationsEnrollmentFunnelRetrieve(requestParameters: OrganizationsApiOrganizationsEnrollmentFunnelRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseEnrollmentCompletionFunnel>;
1774
+ /**
1775
+ *
1776
+ * @summary Program Funnel
1777
+ * @param {OrganizationsApiOrganizationsProgramFunnelRetrieveRequest} requestParameters Request parameters.
1778
+ * @param {*} [options] Override http request option.
1779
+ * @throws {RequiredError}
1780
+ */
1781
+ organizationsProgramFunnelRetrieve(requestParameters: OrganizationsApiOrganizationsProgramFunnelRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgAnalyticsResponseProgramFunnel>;
1782
+ };
1783
+ /**
1784
+ * Request parameters for organizationsContentEngagementRetrieve operation in OrganizationsApi.
1785
+ */
1786
+ export interface OrganizationsApiOrganizationsContentEngagementRetrieveRequest {
1787
+ readonly organization_id: string;
1788
+ readonly limit?: number;
1789
+ readonly offset?: number;
1790
+ }
1791
+ /**
1792
+ * Request parameters for organizationsContractUtilizationRetrieve operation in OrganizationsApi.
1793
+ */
1794
+ export interface OrganizationsApiOrganizationsContractUtilizationRetrieveRequest {
1795
+ readonly organization_id: string;
1796
+ readonly limit?: number;
1797
+ readonly offset?: number;
1798
+ }
1799
+ /**
1800
+ * Request parameters for organizationsEngagementTrendRetrieve operation in OrganizationsApi.
1801
+ */
1802
+ export interface OrganizationsApiOrganizationsEngagementTrendRetrieveRequest {
1803
+ readonly organization_id: string;
1804
+ readonly limit?: number;
1805
+ readonly offset?: number;
1806
+ }
1807
+ /**
1808
+ * Request parameters for organizationsEnrollmentFunnelRetrieve operation in OrganizationsApi.
1809
+ */
1810
+ export interface OrganizationsApiOrganizationsEnrollmentFunnelRetrieveRequest {
1811
+ readonly organization_id: string;
1812
+ readonly limit?: number;
1813
+ readonly offset?: number;
1814
+ }
1815
+ /**
1816
+ * Request parameters for organizationsProgramFunnelRetrieve operation in OrganizationsApi.
1817
+ */
1818
+ export interface OrganizationsApiOrganizationsProgramFunnelRetrieveRequest {
1819
+ readonly organization_id: string;
1820
+ readonly limit?: number;
1821
+ readonly offset?: number;
1822
+ }
1823
+ /**
1824
+ * OrganizationsApi - object-oriented interface
1825
+ */
1826
+ export declare class OrganizationsApi extends BaseAPI {
1827
+ /**
1828
+ *
1829
+ * @summary Content Engagement
1830
+ * @param {OrganizationsApiOrganizationsContentEngagementRetrieveRequest} requestParameters Request parameters.
1831
+ * @param {*} [options] Override http request option.
1832
+ * @throws {RequiredError}
1833
+ */
1834
+ organizationsContentEngagementRetrieve(requestParameters: OrganizationsApiOrganizationsContentEngagementRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseContentEngagementDepth, any, {}, any>>;
1835
+ /**
1836
+ *
1837
+ * @summary Contract Utilization
1838
+ * @param {OrganizationsApiOrganizationsContractUtilizationRetrieveRequest} requestParameters Request parameters.
1839
+ * @param {*} [options] Override http request option.
1840
+ * @throws {RequiredError}
1841
+ */
1842
+ organizationsContractUtilizationRetrieve(requestParameters: OrganizationsApiOrganizationsContractUtilizationRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseContractUtilization, any, {}, any>>;
1843
+ /**
1844
+ *
1845
+ * @summary Engagement Trend
1846
+ * @param {OrganizationsApiOrganizationsEngagementTrendRetrieveRequest} requestParameters Request parameters.
1847
+ * @param {*} [options] Override http request option.
1848
+ * @throws {RequiredError}
1849
+ */
1850
+ organizationsEngagementTrendRetrieve(requestParameters: OrganizationsApiOrganizationsEngagementTrendRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseMonthlyEngagementTrend, any, {}, any>>;
1851
+ /**
1852
+ *
1853
+ * @summary Enrollment Funnel
1854
+ * @param {OrganizationsApiOrganizationsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
1855
+ * @param {*} [options] Override http request option.
1856
+ * @throws {RequiredError}
1857
+ */
1858
+ organizationsEnrollmentFunnelRetrieve(requestParameters: OrganizationsApiOrganizationsEnrollmentFunnelRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseEnrollmentCompletionFunnel, any, {}, any>>;
1859
+ /**
1860
+ *
1861
+ * @summary Program Funnel
1862
+ * @param {OrganizationsApiOrganizationsProgramFunnelRetrieveRequest} requestParameters Request parameters.
1863
+ * @param {*} [options] Override http request option.
1864
+ * @throws {RequiredError}
1865
+ */
1866
+ organizationsProgramFunnelRetrieve(requestParameters: OrganizationsApiOrganizationsProgramFunnelRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgAnalyticsResponseProgramFunnel, any, {}, any>>;
1867
+ }
1868
+ //# sourceMappingURL=api.d.ts.map