REST API reference¶
Admin SDK REST API reference¶
Collect Google Workspace Admin SDK information from the following APIs.
| Resources | Description | API endpoint |
|---|---|---|
| Reports:login | Lists information on account user login activities, based on application name | GET https://www.googleapis.com/admin/reports/v1/activity/users/all/applications/login?endTime=end date&startTime=start date&maxResults=maximum number of events returned on a response page |
| Reports:token | Lists token event information about third party websites and applications, based on application name. | GET https://www.googleapis.com/admin/reports/v1/activity/users/all/applications/token?endTime=end datestartTime=start date&maxResults=maximum number of events returned on a response page |
| Reports:user activity | Lists Google Workspace service user activities event information, based on application name. | GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date?parameters=application: user usage parameter,...&filters=application: user usage parameter relational operator usage parameter's value,...&maxResults=number of events listed on each page of the report |
| Reports:admin | Lists admin event information on the Admin console activities of all of your account’s administrators, based on application | GET https://www.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?endTime=a date&startTime=a date&maxResults=number of events listed on each page of the report |
admin/reports/v1/activity/users/all/applications/login¶
https://www.googleapis.com/admin/reports/v1/activity/users/all/applications/login?endTime=end date&startTime=start date&maxResults=maximum number of events returned on a response page.
GET
Lists information on account user login activities, based on application name
Request parameters None
Returned values Gets a report on all of your account’s user login events for the past 180 days.
admin/reports/v1/activity/users/all/applications/token¶
https://www.googleapis.com/admin/reports/v1/activity/users/all/applications/token?endTime=end date&startTime=start date&maxResults=maximum number of events returned on a response page
GET
Lists token event information about third party websites and applications, based on application name
Request parameters None
Returned values Gets a report on all of your account’s third party websites and application authorization events for the past 180 days.
admin/reports/v1/usage/users¶
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date?parameters=application: user usage parameter,...&filters=application: user usage parameter relational operator usage parameter's value,...&maxResults=number of events listed on each page of the report
GET
Lists Google Workspace service user activities event information, based on application name.
Request parameters None
Returned values Gets a report on all Google Workspace service user activities for the account.
admin/reports/v1/activity/users/all/applications/admin¶
https://www.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?endTime=a date&startTime=a date&maxResults=number of events listed on each page of the report
GET
Lists admin event information on the Admin console activities of all of your account’s administrators, based on application name.
Request parameters None
Returned values Gets a report on all of your account’s Admin console activities for the past 180 days which is the maximum time period for a report.