v5

latestOpenAPI 3.1.02026-08-081,0211,3082.1 MB
DATABRICKS
Databricks
Databricks Users

Get all users with query statistics

Get all users with query statistics.

get/api/v1/databricks/users

Query parameters

start_datestring date nullable

Start date (inclusive) for query / cost statistics. Defaults to 30 days before end_date.

Start date (inclusive) for query / cost statistics. Defaults to 30 days before end_date.

end_datestring date nullable

End date (inclusive). Defaults to today.

End date (inclusive). Defaults to today.

workspace_idstring nullable

Filter by workspace ID

Filter by workspace ID

pageinteger

Page number (1-indexed)

Page number (1-indexed)

page_sizeinteger

Items per page

Items per page

sortAttributestring nullable

Sort column name. Valid columns: user_name, total_queries, successful_queries, failed_queries, avg_duration_ms, max_duration_ms, total_duration_ms, total_read_bytes, total_spilled_bytes, last_query_time, total_dbus, total_cost (cost columns sorted with zeros/nulls last).

Sort column name. Valid columns: user_name, total_queries, successful_queries, failed_queries, avg_duration_ms, max_duration_ms, total_duration_ms, total_read_bytes, total_spilled_bytes, last_query_time, total_dbus, total_cost (cost columns sorted with zeros/nulls last).

sortOrderstring nullable

Sort direction: 'asc' or 'desc'

Sort direction: 'asc' or 'desc'

user_namesstring[] nullable

Filter by user names

Filter by user names

user_typesDatabricksUserType[] nullable

Filter by identity type(s). Repeat to combine: 'USER', 'SERVICE_PRINCIPAL'

Filter by identity type(s). Repeat to combine: 'USER', 'SERVICE_PRINCIPAL'

navigationSourcestring nullable

Headers

x-tenantstring required

Response

Successful Response

total_countinteger required

Total number of users

pageinteger

Current page number

page_sizeinteger

Items per page

total_pagesinteger

Total number of pages