Get app utilization (app dashboard)

Returns one row per app the client has usage data for in the reporting period, with usage metrics, certifications, and lifecycle classification. This is the data backing the SaaS Management app dashboard.

sort accepts canonical_name, unique_users, active_time, avg_time, or session_count, with a - prefix for descending order; defaults to canonical_name ascending.

filter[app_id], filter[user_id], filter[department_id], filter[category_id], filter[vendor_id], filter[approval_status], filter[is_favorite], and filter[lifecycle] narrow the result set — see the filter parameter description for operator support per field. filter[user_id] and filter[department_id] additionally restrict unique_users, avg_time_ms_per_day, and session_count to activity from the given user(s)/department; an app with no matching activity is omitted rather than returned with zeroed metrics.

q searches by app name. has_compliance_gap, missing_frameworks, and compliance_frameworks filter on certification status.

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique ScalePad client identifier.

Query Params
date
required

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

date
required

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

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.

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. Supported fields and operators: app_id (eq, in), user_id (eq, in), department_id (eq, in), category_id (eq, in), vendor_id (eq, in), approval_status (eq, in — approved, not_approved, unreviewed), is_favorite (eq — true/false), lifecycle (eq — discovered, dropped_off, restricting to apps first seen, or that stopped being used, within the date range).

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.

integer
1 to 200
Defaults to 50

Number of rows per page (1-200).

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.

boolean

Restrict to scanned apps that are missing a current self-declared alignment for at least one of the client's required compliance 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.

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.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json