@instructure/athena-api-client 4.4.3 → 4.4.4
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.
package/dist/apis/AdminApi.d.ts
CHANGED
|
@@ -389,22 +389,22 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
389
389
|
*/
|
|
390
390
|
adminGetUserEngagement(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminUserEngagement>;
|
|
391
391
|
/**
|
|
392
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
392
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
393
393
|
* Get per-day activity for a batch of users
|
|
394
394
|
*/
|
|
395
395
|
adminGetUsersActivityRaw(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivity>>>;
|
|
396
396
|
/**
|
|
397
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
397
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
398
398
|
* Get per-day activity for a batch of users
|
|
399
399
|
*/
|
|
400
400
|
adminGetUsersActivity(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivity>>;
|
|
401
401
|
/**
|
|
402
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
402
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
403
403
|
* Get lifetime activity totals for a batch of users
|
|
404
404
|
*/
|
|
405
405
|
adminGetUsersActivityTotalsRaw(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivityTotals>>>;
|
|
406
406
|
/**
|
|
407
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
407
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
408
408
|
* Get lifetime activity totals for a batch of users
|
|
409
409
|
*/
|
|
410
410
|
adminGetUsersActivityTotals(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivityTotals>>;
|
package/dist/apis/AdminApi.js
CHANGED
|
@@ -680,7 +680,7 @@ class AdminApi extends runtime.BaseAPI {
|
|
|
680
680
|
});
|
|
681
681
|
}
|
|
682
682
|
/**
|
|
683
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
683
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
684
684
|
* Get per-day activity for a batch of users
|
|
685
685
|
*/
|
|
686
686
|
adminGetUsersActivityRaw(requestParameters, initOverrides) {
|
|
@@ -712,7 +712,7 @@ class AdminApi extends runtime.BaseAPI {
|
|
|
712
712
|
});
|
|
713
713
|
}
|
|
714
714
|
/**
|
|
715
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
715
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
716
716
|
* Get per-day activity for a batch of users
|
|
717
717
|
*/
|
|
718
718
|
adminGetUsersActivity(requestParameters, initOverrides) {
|
|
@@ -722,7 +722,7 @@ class AdminApi extends runtime.BaseAPI {
|
|
|
722
722
|
});
|
|
723
723
|
}
|
|
724
724
|
/**
|
|
725
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
725
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
726
726
|
* Get lifetime activity totals for a batch of users
|
|
727
727
|
*/
|
|
728
728
|
adminGetUsersActivityTotalsRaw(requestParameters, initOverrides) {
|
|
@@ -754,7 +754,7 @@ class AdminApi extends runtime.BaseAPI {
|
|
|
754
754
|
});
|
|
755
755
|
}
|
|
756
756
|
/**
|
|
757
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
757
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
758
758
|
* Get lifetime activity totals for a batch of users
|
|
759
759
|
*/
|
|
760
760
|
adminGetUsersActivityTotals(requestParameters, initOverrides) {
|
|
@@ -389,22 +389,22 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
389
389
|
*/
|
|
390
390
|
adminGetUserEngagement(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminUserEngagement>;
|
|
391
391
|
/**
|
|
392
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
392
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
393
393
|
* Get per-day activity for a batch of users
|
|
394
394
|
*/
|
|
395
395
|
adminGetUsersActivityRaw(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivity>>>;
|
|
396
396
|
/**
|
|
397
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
397
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
398
398
|
* Get per-day activity for a batch of users
|
|
399
399
|
*/
|
|
400
400
|
adminGetUsersActivity(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivity>>;
|
|
401
401
|
/**
|
|
402
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
402
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
403
403
|
* Get lifetime activity totals for a batch of users
|
|
404
404
|
*/
|
|
405
405
|
adminGetUsersActivityTotalsRaw(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivityTotals>>>;
|
|
406
406
|
/**
|
|
407
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
407
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
408
408
|
* Get lifetime activity totals for a batch of users
|
|
409
409
|
*/
|
|
410
410
|
adminGetUsersActivityTotals(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivityTotals>>;
|
|
@@ -677,7 +677,7 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
677
677
|
});
|
|
678
678
|
}
|
|
679
679
|
/**
|
|
680
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
680
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
681
681
|
* Get per-day activity for a batch of users
|
|
682
682
|
*/
|
|
683
683
|
adminGetUsersActivityRaw(requestParameters, initOverrides) {
|
|
@@ -709,7 +709,7 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
709
709
|
});
|
|
710
710
|
}
|
|
711
711
|
/**
|
|
712
|
-
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in
|
|
712
|
+
* Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in any chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
|
|
713
713
|
* Get per-day activity for a batch of users
|
|
714
714
|
*/
|
|
715
715
|
adminGetUsersActivity(requestParameters, initOverrides) {
|
|
@@ -719,7 +719,7 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
719
719
|
});
|
|
720
720
|
}
|
|
721
721
|
/**
|
|
722
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
722
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
723
723
|
* Get lifetime activity totals for a batch of users
|
|
724
724
|
*/
|
|
725
725
|
adminGetUsersActivityTotalsRaw(requestParameters, initOverrides) {
|
|
@@ -751,7 +751,7 @@ export class AdminApi extends runtime.BaseAPI {
|
|
|
751
751
|
});
|
|
752
752
|
}
|
|
753
753
|
/**
|
|
754
|
-
* Returns, for each known external user id, all-time counts of messages sent (in
|
|
754
|
+
* Returns, for each known external user id, all-time counts of messages sent (in any chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
|
|
755
755
|
* Get lifetime activity totals for a batch of users
|
|
756
756
|
*/
|
|
757
757
|
adminGetUsersActivityTotals(requestParameters, initOverrides) {
|
|
@@ -22,7 +22,7 @@ export interface AdminUserActivityTotals {
|
|
|
22
22
|
*/
|
|
23
23
|
externalId: string;
|
|
24
24
|
/**
|
|
25
|
-
* Messages the user sent in
|
|
25
|
+
* Messages the user sent in any chat, all time
|
|
26
26
|
* @type {number}
|
|
27
27
|
* @memberof AdminUserActivityTotals
|
|
28
28
|
*/
|
|
@@ -22,7 +22,7 @@ export interface AdminUserActivityTotals {
|
|
|
22
22
|
*/
|
|
23
23
|
externalId: string;
|
|
24
24
|
/**
|
|
25
|
-
* Messages the user sent in
|
|
25
|
+
* Messages the user sent in any chat, all time
|
|
26
26
|
* @type {number}
|
|
27
27
|
* @memberof AdminUserActivityTotals
|
|
28
28
|
*/
|