Get app utilization with per-app users

get

https://api.scalepad.com/lifecycle-manager/v1/saas-management/clients/{client_id}/apps/utilization/users

Same rows and filters as GET .../apps/utilization, with each app row additionally carrying its top users by average time (users), capped at users_limit. Use this only when the per-user breakdown is needed — it costs one extra query per app row compared to the base endpoint.

Pagination is cursor-based and best-effort/non-atomic: rows may be skipped or duplicated between page requests if the underlying data changes concurrently.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

client_id

string

required

Unique ScalePad client identifier.

Query Params

start_date

date

required

Start of the reporting period (YYYY-MM-DD).

end_date

date

required

End of the reporting period, inclusive (YYYY-MM-DD). The range must not exceed 366 days.

compare_start_date

date

Start of an optional comparison period (YYYY-MM-DD). Must be provided together with compare_end_date. When set, each metric's compare_value, change_value, and change_pct are populated against this period.

compare_end_date

date

End of an optional comparison period, inclusive (YYYY-MM-DD). Must be provided together with compare_start_date.

filter

object

Filter map: filter[field]=op:value. Same supported fields and operators as GET .../apps/utilization.

sort

string

^[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

Comma-separated sort fields: canonical_name, unique_users, active_time, avg_time, or session_count. Prefix a field with - for descending order. Defaults to canonical_name ascending.

page_size

integer

1 to 200

Defaults to 50

Number of rows per page (1-200).

cursor

string

Opaque pagination cursor from a previous response's next_cursor. Pagination is best-effort and non-atomic: rows may be skipped or duplicated across page requests if the underlying data changes between calls.

string

Free-text search over the app's canonical name.

has_compliance_gap

boolean

Restrict to scanned apps that are missing a current self-declared alignment for at least one of the client's required compliance frameworks.

missing_frameworks

string

Comma-separated compliance framework keys (hipaa, soc1, soc2, gdpr, iso27001). Returns scanned apps missing a current self-declared alignment for at least one of the given frameworks.

compliance_frameworks

string

Comma-separated compliance framework keys (hipaa, soc1, soc2, gdpr, iso27001). Returns apps with a current self-declared alignment for at least one of the given frameworks.

users_limit

integer

1 to 200

Defaults to 50

Maximum number of users embedded per app row (1-200).

users_sort

string

Sort for each app's embedded user list: username, avg_time, avg_time_change, or days_active. Prefix with - for descending. Defaults to avg_time descending.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200App dashboard rows for the client, each with its top users.

400The request could not be processed — invalid query parameters.

401Missing or invalid credentials.

402The tenant does not have an active subscription for this product. Distinct from authentication/authorization failures.

403The API key's token does not have the amm.apps-utilization:read scope.

404The client could not be found, or is not owned by the calling tenant.

429Rate limit exceeded for this API key.

500Internal server error.