Integrations
Retool
APIs
List Used Groups and Apps per User

List Used Groups and Apps per User

List all apps a user has used as viewer and/or editor within a certain time range.

Required Permission Scopes:

  • Users > Read
  • Groups > Read
  • Permissions > Read
  • usage

SDK Import:

from admyral.actions import list_used_groups_and_apps_per_user

Arguments

Argument NameDescriptionRequired
Start Date, start_dateThe start date of the time range. Example: 2022-01-01Yes
End Date, end_dateThe end date of the time range. If not specified, then minimum(start_date + 30 days, today - 1) is used. Example: 2022-12-31-

Returns

A list of JSON objects.

Schema:

[
	{
        "user": The user email,
		"used_groups": List of group names the user used within the time range,
        "viewed_apps": Name of the apps the user used within the time range,
        "edited_apps": Name of the apps the user edited within the time range,
	}
]

Required Secrets

Secret PlaceholderDescription
RETOOL_SECRETRetool secret. See Retool setup

SDK Example

groups_per_user = list_used_groups_and_apps_per_user(
    start_date="2024-10-01",
    end_date="2024-10-31",
	secrets={"RETOOL_SECRET": "my_stored_retool_secret"}
)