- Track credit usage across your workspace and by individual users.
- Monitor user activity and identify inactive accounts.
- Audit app security settings.
- Analyze engagement with views, active users, and usage trends.
- Manage seat allocation and utilization.
Workspaces
A workspace is a shared environment where teams collaborate on apps. The Monitoring API provides workspace owners and admins with aggregate data across the users and apps in a specific workspace.Workspace ID
Most endpoints require aworkspace_id in the URL path, and you must have admin or owner role in that workspace to access them.
To get your workspace_id, navigate to your workspace management page:
- Click your profile icon at the top right of your account.
- Hover over the relevant workspace and click Manage.
- The workspace ID is the last part of the workspace management page URL.
Example workflows
Here are some common ways to use the Monitoring API.Compare monthly usage
1
Get current month analytics
Call
Get analytics with this
month’s date range to get current credit consumption and user activity.2
Get previous month analytics
Call
Get analytics again with
last month’s date range to compare trends.Analyze user activity
1
List users
Call
List users to get all users with
summary consumption data for the current billing period.2
Get user
Call
Get user to get consumption data for
a specific user over a custom date range.Audit an app
1
List users
Call
List users to find users in your
workspace.2
List user apps
Call
List user apps to get app IDs
for a specific user.3
Get app analytics
Call
Get app analytics to get
detailed metrics and governance flags for the app.