- Track credit usage across your workspace and by individual users.
- Monitor your workspace credit pool and per-member credit limits.
- Monitor user activity and identify inactive accounts.
- Audit app security settings.
- Analyze engagement with views, active users, and usage trends.
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.
Credit pools and member limits
Your workspace shares a single credit pool for each credit reset period. The pool tracks message and integration credits separately, and each reports its limit, the amount used, and the amount remaining. The reset period matches the one shown in your billing page. For yearly subscriptions that reset monthly, this is the monthly window. TheGet analytics response returns this data in the credit_pool object, including your tier, daily message limits, bonus credits, gift card balance, and over-limit flags.
Workspaces can also set per-member credit limits on how many message credits each member draws from the shared pool. A member’s limit comes from either an individual override or a workspace default. The member_allocations object in the analytics response summarizes these limits across your workspace, and the member_allocation object on each user in Get user reports an individual member’s limit and usage.
Per-member credit limits depend on your workspace tier. When your tier does not support them, members draw from the pool without an individual limit, and the per-member fields return
null.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.Find members over their credit limit
1
List users over their limit
Call
List users with
over_member_limit=true to return only members who have exceeded their
per-member credit limit in the current credit reset period.2
Get member allocation detail
Call
Get user for a specific member to
see their member_allocation, including the limit, the source of the limit,
and the credits remaining.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.