{"openapi":"3.1.0","info":{"title":"Base44 Workspace Monitoring API","description":"\n    Workspace monitoring and analytics API.\n    \n    Access usage analytics, user engagement metrics, and governance data for your workspace.\n    \n    **Features:**\n    - Workspace-level analytics and KPIs\n    - User activity tracking and credit consumption\n    - App engagement metrics and security governance\n    \n    **Authentication:** Required for all endpoints (admin or owner role)\n    \n    Use the 🔒 **Authorize** button above to enter your API key.\n    \n    **Rate Limits:**\n    - Analytics endpoints: 50 requests per minute per user\n    - User list: 50 requests per minute per user\n    - User detail: 75 requests per minute per user\n    - User apps: 50 requests per minute per user\n    - User Superagents: 50 requests per minute per user\n    - App list: 50 requests per minute per user\n    - App analytics: 50 requests per minute per user\n    - Superagent list: 50 requests per minute per user\n    - Superagent analytics: 50 requests per minute per user\n\n    Enterprise workspaces get 2x these limits.\n    \n    Rate limits are applied per authenticated user and enforced using token-bucket algorithm.\n    ","version":"2.0.0"},"paths":{"/health":{"get":{"tags":["system"],"summary":"Health check","description":"Checks that the API is running and ready to respond to requests.","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"security":[]}},"/analytics/{workspace_id}":{"get":{"tags":["analytics"],"summary":"Get analytics","description":"Returns workspace-level analytics including summary KPIs, app distribution per user, the workspace credit pool, per-member credit-limit aggregates, and credit consumption.\n\n    Data is real-time from the database.","operationId":"get_workspace_analytics_analytics__workspace_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in `YYYY-MM-DD` format. Defaults to billing period start.","title":"From"},"description":"Start date in `YYYY-MM-DD` format. Defaults to billing period start.","example":"2026-06-01"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in `YYYY-MM-DD` format. Defaults to current date. Max 1 year range.","title":"To"},"description":"End date in `YYYY-MM-DD` format. Defaults to current date. Max 1 year range.","example":"2026-06-30"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceAnalytics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/users":{"get":{"tags":["users"],"summary":"List users","description":"Returns a list of all users in the workspace with their profile and credit consumption data.\n\n    You can use the `from` and `to` parameters to specify the date range for credit consumption. If not specified, defaults to consumption during the current billing period.\n\n    You can use the returned `user_id` values to call:\n    - [`Get user`](/api-reference/monitoring/users/get-user): For user consumption data for a specific user over a custom date range.\n    - [`List user apps`](/api-reference/monitoring/users/list-user-apps): To see a specific user's app IDs.\n\n    Results are paginated. Check `has_more` in the response and use the returned `cursor` to fetch additional pages.","operationId":"list_users__workspace_id__users_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Items per page. Max 50.","default":50,"title":"Limit"},"description":"Items per page. Max 50."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor from previous response.","title":"Cursor"},"description":"Pagination cursor from previous response."},{"name":"active_only","in":"query","required":false,"schema":{"type":"boolean","description":"Filter to users who consumed message credits in the last 30 days.","default":false,"title":"Active Only"},"description":"Filter to users who consumed message credits in the last 30 days."},{"name":"tier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by workspace tier, such as `\"builder\"`, `\"pro\"`, or `\"enterprise\"`. Use the base tier name, which matches its numbered sub-tiers.","title":"Tier"},"description":"Filter by workspace tier, such as `\"builder\"`, `\"pro\"`, or `\"enterprise\"`. Use the base tier name, which matches its numbered sub-tiers."},{"name":"over_member_limit","in":"query","required":false,"schema":{"type":"boolean","description":"Return only members whose consumption has exceeded their per-member credit limit in the current credit reset period. Has no effect when the workspace tier does not enforce per-member limits.","default":false,"title":"Over Member Limit"},"description":"Return only members whose consumption has exceeded their per-member credit limit in the current credit reset period. Has no effect when the workspace tier does not enforce per-member limits."},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort by `\"email\"`, `\"created_at\"`, `\"role\"`, `\"total_apps\"`, `\"total_superagents\"`, `\"active_last_30d\"`, `\"total_message_credits\"`, `\"total_integration_credits\"`, `\"total_credits\"`, `\"credit_limit\"`, `\"credit_limit_used\"`, or `\"credit_limit_remaining\"`. Prefix with `-` for descending.","title":"Sort"},"description":"Sort by `\"email\"`, `\"created_at\"`, `\"role\"`, `\"total_apps\"`, `\"total_superagents\"`, `\"active_last_30d\"`, `\"total_message_credits\"`, `\"total_integration_credits\"`, `\"total_credits\"`, `\"credit_limit\"`, `\"credit_limit_used\"`, or `\"credit_limit_remaining\"`. Prefix with `-` for descending."},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Case-insensitive email search.","title":"Search"},"description":"Case-insensitive email search."},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by workspace role: `\"owner\"`, `\"admin\"`, `\"editor\"`, `\"viewer\"`, or `\"guest\"`.","title":"Role"},"description":"Filter by workspace role: `\"owner\"`, `\"admin\"`, `\"editor\"`, `\"viewer\"`, or `\"guest\"`."},{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by enabled (`true`) or disabled (`false`) platform user account state.","title":"Is Active"},"description":"Filter by enabled (`true`) or disabled (`false`) platform user account state."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","title":"From"},"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","example":"2026-06-01"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","title":"To"},"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","example":"2026-06-30"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsUserListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/users/{user_id}":{"get":{"tags":["users"],"summary":"Get user","description":"Returns the specified user's profile and credit consumption data for a custom date range.\n\n    You can use the `from` and `to` parameters to specify the date range for credit consumption. If not specified, defaults to consumption during the current billing period.\n    \n    You can also call [`List user apps`](/api-reference/monitoring/users/list-user-apps) to see the apps owned by this user.","operationId":"get_user__workspace_id__users__user_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"User ID. Get this from [`List users`](/api-reference/monitoring/users/list-users).","title":"User Id"},"description":"User ID. Get this from [`List users`](/api-reference/monitoring/users/list-users)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","title":"From"},"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","example":"2026-06-01"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","title":"To"},"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","example":"2026-06-30"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsUserRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/users/{user_id}/apps":{"get":{"tags":["users"],"summary":"List user apps","description":"Returns a list of app IDs for apps created by the specified user.\n\n    Get `user_id` values from [`List users`](/api-reference/monitoring/users/list-users).\n\n    You can use the returned `app_id` values to call [`Get app analytics`](/api-reference/monitoring/apps/get-app-analytics) for detailed app information.\n\n    Optional filters and sorts mirror the workspace-wide [`List app metrics`](/api-reference/monitoring/apps/list-app-metrics) endpoint while preserving the compact `app_ids` response.\n    \n    Results are paginated. Check `has_more` in the response and use the returned `cursor` to fetch additional pages.","operationId":"get_user_apps__workspace_id__users__user_id__apps_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"User ID.","title":"User Id"},"description":"User ID."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Items per page. Max 50.","default":50,"title":"Limit"},"description":"Items per page. Max 50."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor from previous response.","title":"Cursor"},"description":"Pagination cursor from previous response."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `to` is provided. Defaults to billing period start.","title":"From"},"description":"Start date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `to` is provided. Defaults to billing period start.","example":"2026-06-01"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `from` is provided. Defaults to current date.","title":"To"},"description":"End date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `from` is provided. Defaults to current date.","example":"2026-06-30"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"app_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"last_published\"`, `\"is_published\"`, `\"views_last_30d\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`.","title":"Sort"},"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"app_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"last_published\"`, `\"is_published\"`, `\"views_last_30d\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`."},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Case-insensitive search over app name and creator email.","title":"Search"},"description":"Case-insensitive search over app name and creator email."},{"name":"is_published","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter to published (`true`) or unpublished (`false`) apps.","title":"Is Published"},"description":"Filter to published (`true`) or unpublished (`false`) apps."},{"name":"visibility","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by app visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`.","title":"Visibility"},"description":"Filter by app visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`."},{"name":"active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter to apps with (`true`) or without (`false`) views in the last 30 days.","title":"Active"},"description":"Filter to apps with (`true`) or without (`false`) views in the last 30 days."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsUserAppsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/users/{user_id}/superagents":{"get":{"tags":["users"],"summary":"List user Superagents","description":"Returns a list of Superagent IDs for Superagents owned by the specified user.\n\n    Get `user_id` values from [`List users`](/api-reference/monitoring/users/list-users).\n\n    You can use the returned `superagent_id` values to call [`Get Superagent analytics`](/api-reference/monitoring/superagents/get-superagent-analytics) for detailed Superagent information.\n\n    Supports visibility, search, sort, and date-range filters plus an `active` filter. \n\n    Results are paginated. Check `has_more` in the response and use the returned `cursor` to fetch additional pages.","operationId":"get_user_superagents__workspace_id__users__user_id__superagents_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"User ID.","title":"User Id"},"description":"User ID."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Items per page. Max 50.","default":50,"title":"Limit"},"description":"Items per page. Max 50."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor from previous response.","title":"Cursor"},"description":"Pagination cursor from previous response."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `to` is provided. Defaults to billing period start.","title":"From"},"description":"Start date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `to` is provided. Defaults to billing period start.","example":"2026-06-01"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `from` is provided. Defaults to current date.","title":"To"},"description":"End date in `YYYY-MM-DD` format for credit-consuming sort fields. Required if `from` is provided. Defaults to current date.","example":"2026-06-30"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"superagent_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`.","title":"Sort"},"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"superagent_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`."},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Case-insensitive search over Superagent name and creator email.","title":"Search"},"description":"Case-insensitive search over Superagent name and creator email."},{"name":"visibility","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Superagent visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`.","title":"Visibility"},"description":"Filter by Superagent visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`."},{"name":"active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter to Superagents with (`true`) or without (`false`) users who messaged the Superagent directly in the last 30 days.","title":"Active"},"description":"Filter to Superagents with (`true`) or without (`false`) users who messaged the Superagent directly in the last 30 days."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsUserSuperAgentsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/apps":{"get":{"tags":["apps"],"summary":"List app metrics","description":"Returns a paginated workspace-wide app inventory with owner, visibility, publish, activity, and credit-usage metrics.\n\n    This endpoint avoids client-side fan-out through every workspace user when building full app inventory views.","operationId":"list_apps__workspace_id__apps_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Items per page. Max 50.","default":50,"title":"Limit"},"description":"Items per page. Max 50."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor from previous response.","title":"Cursor"},"description":"Pagination cursor from previous response."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","title":"From"},"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","example":"2026-06-01"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","title":"To"},"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","example":"2026-06-30"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"app_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"last_published\"`, `\"is_published\"`, `\"views_last_30d\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`.","title":"Sort"},"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"app_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"last_published\"`, `\"is_published\"`, `\"views_last_30d\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`."},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Case-insensitive search over app name and creator email.","title":"Search"},"description":"Case-insensitive search over app name and creator email."},{"name":"is_published","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter to published (`true`) or unpublished (`false`) apps.","title":"Is Published"},"description":"Filter to published (`true`) or unpublished (`false`) apps."},{"name":"visibility","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by app visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`.","title":"Visibility"},"description":"Filter by app visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceAppListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/superagents":{"get":{"tags":["superagents"],"summary":"List Superagents","description":"Returns a paginated workspace-wide Superagent inventory with owner, activity, and credit-usage metrics.\n\n    Filter by visibility or search Superagents by name and creator email.","operationId":"list_superagents__workspace_id__superagents_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Items per page. Max 50.","default":50,"title":"Limit"},"description":"Items per page. Max 50."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor from previous response.","title":"Cursor"},"description":"Pagination cursor from previous response."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","title":"From"},"description":"Start date in `YYYY-MM-DD` format. Required if `to` is provided. Defaults to billing period start.","example":"2026-06-01"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","title":"To"},"description":"End date in `YYYY-MM-DD` format. Required if `from` is provided. Defaults to current date.","example":"2026-06-30"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"superagent_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`.","title":"Sort"},"description":"Sort field. Prefix with `-` for descending. Supported fields: `\"superagent_name\"`, `\"created_at\"`, `\"created_by_email\"`, `\"owner_user_id\"`, `\"active_users_last_30d\"`, `\"message_credits_consumed\"`, `\"integration_credits_consumed\"`, `\"total_credits_consumed\"`."},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Case-insensitive search over Superagent name and creator email.","title":"Search"},"description":"Case-insensitive search over Superagent name and creator email."},{"name":"visibility","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Superagent visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`.","title":"Visibility"},"description":"Filter by Superagent visibility. Accepts `\"private\"`, `\"workspace\"`, `\"public_with_login\"`, `\"public_without_login\"`, or `\"public\"`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSuperAgentListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/apps/{app_id}/analytics":{"get":{"tags":["apps"],"summary":"Get app analytics","description":"Returns detailed analytics for the specified app, including engagement metrics, deployment info, and governance flags.\n\n    Get `app_id` values from [`List user apps`](/api-reference/monitoring/users/list-user-apps).\n\n    <Note>The `avg_session_duration_sec` field always returns 0 as session tracking has not been implemented yet.</Note>","operationId":"get_app_analytics__workspace_id__apps__app_id__analytics_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"app_id","in":"path","required":true,"schema":{"type":"string","description":"App ID.","title":"App Id"},"description":"App ID."},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Start date in `YYYY-MM-DD` format.","title":"From"},"description":"Start date in `YYYY-MM-DD` format.","example":"2026-06-01"},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"End date in `YYYY-MM-DD` format.","title":"To"},"description":"End date in `YYYY-MM-DD` format.","example":"2026-06-30"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAnalytics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/{workspace_id}/superagents/{agent_id}/analytics":{"get":{"tags":["superagents"],"summary":"Get Superagent analytics","description":"Returns detailed analytics for the specified Superagent, including active-user and credit-usage metrics.\n\n    Get `agent_id` values from [`List Superagents`](/api-reference/monitoring/superagents/list-superagents) or [`List user Superagents`](/api-reference/monitoring/users/list-user-superagents).","operationId":"get_superagent_analytics__workspace_id__superagents__agent_id__analytics_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","description":"Superagent ID.","title":"Agent Id"},"description":"Superagent ID."},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Start date in `YYYY-MM-DD` format.","title":"From"},"description":"Start date in `YYYY-MM-DD` format.","example":"2026-06-01"},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"End date in `YYYY-MM-DD` format.","title":"To"},"description":"End date in `YYYY-MM-DD` format.","example":"2026-06-30"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperAgentAnalytics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AnalyticsAppCountBucket":{"properties":{"range":{"type":"string","title":"Range","description":"App count range, such as `\"0\"`, `\"1-2\"`, `\"3-5\"`, `\"6-10\"`, or `\"10+\"`.","example":"1-2"},"count":{"type":"integer","title":"Count","description":"Number of users in this range.","example":25}},"type":"object","required":["range","count"],"title":"AnalyticsAppCountBucket","description":"Single bucket in app count distribution histogram."},"AnalyticsAppDistribution":{"properties":{"apps_per_user_ranges":{"items":{"$ref":"#/components/schemas/AnalyticsAppCountBucket"},"type":"array","title":"Apps Per User Ranges","description":"Distribution of users by number of apps they own."},"median_apps_per_user":{"type":"number","title":"Median Apps Per User","description":"Median number of apps per user.","example":2.5},"total_users":{"type":"integer","title":"Total Users","description":"Total number of users.","example":42}},"type":"object","required":["apps_per_user_ranges","median_apps_per_user","total_users"],"title":"AnalyticsAppDistribution","description":"App distribution statistics."},"AnalyticsCreditBucket":{"properties":{"range":{"type":"string","title":"Range","description":"Credit range. For example, `\"0\"`, `\"1-10\"`, or `\"11-50\"`.","example":"11-50"},"count":{"type":"integer","title":"Count","description":"Number of users in the range.","example":18}},"type":"object","required":["range","count"],"title":"AnalyticsCreditBucket","description":"Single bucket in credit distribution histogram"},"AnalyticsSummary":{"properties":{"total_applications":{"type":"integer","title":"Total Applications","description":"Total number of apps.","example":127},"total_superagents":{"type":"integer","title":"Total Superagents","description":"Total number of Superagents.","example":7},"avg_apps_per_user":{"type":"number","minimum":0.0,"title":"Avg Apps Per User","description":"Average number of apps per user.","example":3.2},"avg_superagents_per_user":{"type":"number","minimum":0.0,"title":"Avg Superagents Per User","description":"Average number of Superagents per user.","example":0.4},"total_registered_users":{"type":"integer","title":"Total Registered Users","description":"Total number of active workspace users, including guests.","example":42},"total_workspace_members":{"type":"integer","title":"Total Workspace Members","description":"Total number of active non-guest workspace users.","example":36},"total_guest_users":{"type":"integer","title":"Total Guest Users","description":"Total number of active guest users.","example":6},"active_users_last_30d":{"type":"integer","title":"Active Users Last 30D","description":"Number of users who consumed message credits in the last 30 days.","example":38},"published_apps":{"type":"integer","title":"Published Apps","description":"Number of published apps.","example":89}},"type":"object","required":["total_applications","total_superagents","avg_apps_per_user","avg_superagents_per_user","total_registered_users","total_workspace_members","total_guest_users","active_users_last_30d","published_apps"],"title":"AnalyticsSummary","description":"High-level workspace analytics summary."},"AnalyticsUserAppsResponse":{"properties":{"app_ids":{"items":{"type":"string"},"type":"array","title":"App Ids","description":"List of app IDs."},"pagination":{"$ref":"#/components/schemas/PaginationMetadata","description":"Pagination metadata."}},"type":"object","required":["app_ids","pagination"],"title":"AnalyticsUserAppsResponse","description":"Simplified user apps response. Returns app IDs only."},"AnalyticsUserDistribution":{"properties":{"total_users":{"type":"integer","title":"Total Users","description":"Total number of users.","example":42}},"type":"object","required":["total_users"],"title":"AnalyticsUserDistribution","description":"User distribution breakdown."},"AnalyticsUserListResponse":{"properties":{"users":{"items":{"$ref":"#/components/schemas/AnalyticsUserRecord"},"type":"array","title":"Users","description":"List of users."},"pagination":{"$ref":"#/components/schemas/PaginationMetadata","description":"Pagination metadata."}},"type":"object","required":["users","pagination"],"title":"AnalyticsUserListResponse","description":"Paginated list of users."},"AnalyticsUserRecord":{"properties":{"user_id":{"type":"string","title":"User Id","description":"Unique user identifier.","example":"usr_abc123"},"email":{"type":"string","format":"email","title":"Email","description":"User email address.","example":"jane.doe@company.com"},"created_at":{"type":"string","title":"Created At","description":"User registration date in `YYYY-MM-DDTHH:MM:SSZ` format.","example":"2024-03-15T10:30:00Z"},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the user account is enabled (not disabled).","example":true},"role":{"type":"string","title":"Role","description":"Workspace role. One of `\"owner\"`, `\"admin\"`, `\"editor\"`, `\"viewer\"`, `\"member\"`, or `\"guest\"`.","example":"member"},"total_apps":{"type":"integer","minimum":0.0,"title":"Total Apps","description":"Total number of active regular apps owned by this user.","example":12},"total_superagents":{"type":"integer","minimum":0.0,"title":"Total Superagents","description":"Total number of Superagents owned by this user.","example":3},"active_last_30d":{"type":"boolean","title":"Active Last 30D","description":"Whether the user consumed message credits in the last 30 days.","example":true},"total_message_credits":{"type":"number","minimum":0.0,"title":"Total Message Credits","description":"Total message credits consumed in the requested date range.","example":1250},"total_integration_credits":{"type":"number","minimum":0.0,"title":"Total Integration Credits","description":"Total integration credits consumed in the requested date range.","example":340},"total_credits":{"type":"number","minimum":0.0,"title":"Total Credits","description":"Total credits consumed in the requested date range.","example":1590},"member_allocation":{"anyOf":[{"$ref":"#/components/schemas/MemberCreditAllocation"},{"type":"null"}],"description":"Per-member credit limit status for the current credit reset period. `null` when the workspace tier does not enforce per-member limits."}},"type":"object","required":["user_id","email","created_at","is_active","role","total_apps","total_superagents","active_last_30d","total_message_credits","total_integration_credits","total_credits"],"title":"AnalyticsUserRecord","description":"Detailed user information with consumption data."},"AnalyticsUserSuperAgentsResponse":{"properties":{"superagent_ids":{"items":{"type":"string"},"type":"array","title":"Superagent Ids","description":"List of Superagent IDs."},"pagination":{"$ref":"#/components/schemas/PaginationMetadata","description":"Pagination metadata."}},"type":"object","required":["superagent_ids","pagination"],"title":"AnalyticsUserSuperAgentsResponse","description":"Simplified user Superagents response. Returns Superagent IDs only."},"AppAnalytics":{"properties":{"app_id":{"type":"string","title":"App Id","description":"App identifier.","example":"app_abc123"},"app_name":{"type":"string","title":"App Name","description":"App name.","example":"Sales Dashboard"},"unique_users":{"type":"integer","minimum":0.0,"title":"Unique Users","description":"Number of unique users.","example":156},"total_views":{"type":"integer","minimum":0.0,"title":"Total Views","description":"Total number of views.","example":2847},"avg_session_duration_sec":{"type":"number","minimum":0.0,"title":"Avg Session Duration Sec","description":"Average session duration in seconds.","example":0},"views_last_7d":{"type":"integer","minimum":0.0,"title":"Views Last 7D","description":"Views in last 7 days.","example":312},"views_last_30d":{"type":"integer","minimum":0.0,"title":"Views Last 30D","description":"Views in last 30 days.","example":1205},"active_users_last_7d":{"type":"integer","minimum":0.0,"title":"Active Users Last 7D","description":"Number of users who viewed the app in the last 7 days.","example":42},"active_users_last_30d":{"type":"integer","minimum":0.0,"title":"Active Users Last 30D","description":"Number of users who viewed the app in the last 30 days.","example":89},"message_credits_consumed":{"type":"number","minimum":0.0,"title":"Message Credits Consumed","description":"Message credits consumed by this app.","example":4250},"integration_credits_consumed":{"type":"number","minimum":0.0,"title":"Integration Credits Consumed","description":"Integration credits consumed by this app.","example":875},"daily_views":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Daily Views","description":"Daily view counts.","example":[{"date":"2026-06-29","views":45},{"date":"2026-06-30","views":52}]},"last_published":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Published","description":"Last publish date in `YYYY-MM-DDTHH:MM:SSZ` format.","example":"2025-01-10T14:30:00Z"},"visibility":{"type":"string","title":"Visibility","description":"App visibility, such as `\"Public\"`, `\"Public (with login)\"`, `\"Workspace\"`, or `\"Private\"`.","example":"Public (with login)"},"has_agent":{"type":"boolean","title":"Has Agent","description":"Whether an AI agent is active in the app.","example":true},"has_backend_function":{"type":"boolean","title":"Has Backend Function","description":"Whether backend functions are enabled for the app.","example":false},"has_authentication":{"type":"boolean","title":"Has Authentication","description":"Whether any auth method is enabled.","example":true},"has_sso":{"type":"boolean","title":"Has Sso","description":"Whether SSO is enabled.","example":false},"has_secrets":{"type":"boolean","title":"Has Secrets","description":"Whether secrets are defined for the app.","example":true}},"type":"object","required":["app_id","app_name","unique_users","total_views","avg_session_duration_sec","views_last_7d","views_last_30d","active_users_last_7d","active_users_last_30d","message_credits_consumed","integration_credits_consumed","daily_views","visibility","has_agent","has_backend_function","has_authentication","has_sso","has_secrets"],"title":"AppAnalytics","description":"Detailed analytics for a specific app"},"CreditPool":{"properties":{"period_start":{"type":"string","title":"Period Start","description":"Start of the credit reset period in `YYYY-MM-DDTHH:MM:SSZ` format.","example":"2025-10-01T00:00:00Z"},"period_end":{"type":"string","title":"Period End","description":"End of the credit reset period in `YYYY-MM-DDTHH:MM:SSZ` format.","example":"2025-11-01T00:00:00Z"},"tier":{"type":"string","title":"Tier","description":"Subscription tier identifier, such as `\"free\"`, `\"builder\"`, `\"business_1\"`, or `\"enterprise\"`.","example":"enterprise"},"tier_display_name":{"type":"string","title":"Tier Display Name","description":"Human-readable tier name.","example":"Enterprise"},"messages":{"$ref":"#/components/schemas/CreditPoolBucket","description":"Message credit pool. The `limit` includes monthly tier credits, bonus credits, and any gift-card balance. `gift_card_credits_remaining` is already counted in `limit` and is shown separately for visibility only. Don't add it to `limit`."},"integration":{"$ref":"#/components/schemas/CreditPoolBucket","description":"Integration credit pool. Includes monthly tier limit + bonus."},"daily_message_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Daily Message Limit","description":"Daily message credit limit. `null` when no daily limit applies."},"daily_message_used":{"type":"number","minimum":0.0,"title":"Daily Message Used","description":"Message credits consumed today.","example":320},"bonus_message_credits":{"type":"integer","minimum":0.0,"title":"Bonus Message Credits","description":"Active workspace bonus message credits included in `messages.limit`.","example":500},"bonus_integration_credits":{"type":"integer","minimum":0.0,"title":"Bonus Integration Credits","description":"Active workspace bonus integration credits included in `integration.limit`.","example":0},"rollover_message_credits":{"type":"integer","minimum":0.0,"title":"Rollover Message Credits","description":"**Deprecated:** Message rollover credits. Removed in the current billing model. There is no rollover, so this always reports `0` and is retained only for response-shape compatibility.","deprecated":true},"rollover_integration_credits":{"type":"integer","minimum":0.0,"title":"Rollover Integration Credits","description":"**Deprecated:** Integration rollover credits. Removed in the current billing model. There is no rollover, so this always reports `0` and is retained only for response-shape compatibility.","deprecated":true},"gift_card_credits_remaining":{"type":"number","minimum":0.0,"title":"Gift Card Credits Remaining","description":"Gift card balance available to the workspace. Consumed before tier credits. This balance is already counted in `messages.limit` and is shown here for visibility only. Don't add it to `messages.limit`. Reported as a float to preserve fractional balances.","example":0},"is_over_limit":{"type":"boolean","title":"Is Over Limit","description":"Whether the workspace has exceeded its monthly or daily message credit limit.","example":false},"is_past_due":{"type":"boolean","title":"Is Past Due","description":"Whether the subscription is past due. Limits may be downgraded when past due.","example":false}},"type":"object","required":["period_start","period_end","tier","tier_display_name","messages","integration","daily_message_limit","daily_message_used","bonus_message_credits","bonus_integration_credits","rollover_message_credits","rollover_integration_credits","gift_card_credits_remaining","is_over_limit","is_past_due"],"title":"CreditPool","description":"Workspace credit pool state for the current credit reset period.\n\nThe `messages` and\n`integration` fields each report their own limit/used/remaining. The\nperiod is the credit reset window, which matches the billing UI. For\nyearly subscriptions with monthly resets, this is the monthly window."},"CreditPoolBucket":{"properties":{"limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Limit","description":"Credits available in the pool for the current period. `null` means unlimited. Reported as a float to preserve fractional balances and consumption.","example":20000},"used":{"type":"number","minimum":0.0,"title":"Used","description":"Credits consumed in the current period.","example":12450},"remaining":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Remaining","description":"Credits remaining. `null` when `limit` is `null` (unlimited).","example":7550}},"type":"object","required":["limit","used","remaining"],"title":"CreditPoolBucket","description":"Limit/used/remaining for one portion of the workspace credit pool."},"CreditsSummary":{"properties":{"message_credits":{"type":"number","title":"Message Credits","description":"Total message credits consumed.","example":12450},"integration_credits":{"type":"number","title":"Integration Credits","description":"Total integration credits consumed.","example":3280},"total_credits":{"type":"number","title":"Total Credits","description":"Combined total credits consumed. Calculated as `message_credits` + `integration_credits`.","example":15730},"message_credits_distribution":{"items":{"$ref":"#/components/schemas/AnalyticsCreditBucket"},"type":"array","title":"Message Credits Distribution","description":"Distribution of users by message credit usage."},"integration_credits_distribution":{"items":{"$ref":"#/components/schemas/AnalyticsCreditBucket"},"type":"array","title":"Integration Credits Distribution","description":"Distribution of users by integration credit usage."}},"type":"object","required":["message_credits","integration_credits","total_credits"],"title":"CreditsSummary","description":"Credits consumption summary"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Health status. Always 'healthy' if responding.","example":"healthy"},"service":{"type":"string","title":"Service","description":"Service name.","example":"monitoring-api"},"version":{"type":"string","title":"Version","description":"API version.","example":"2.0.0"}},"type":"object","required":["status","service","version"],"title":"HealthResponse","description":"Response for the health check endpoint."},"MemberAllocationsSummary":{"properties":{"members_with_limit":{"type":"integer","minimum":0.0,"title":"Members With Limit","description":"Number of members who have an effective per-member credit limit.","example":18},"members_over_limit":{"type":"integer","minimum":0.0,"title":"Members Over Limit","description":"Number of members who have exceeded their per-member limit in the current credit reset period.","example":2},"default_member_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Default Member Limit","description":"Default per-member credit limit applied per credit reset period to members without an explicit override. `null` when no default is set.","example":1000},"capability_enabled":{"type":"boolean","title":"Capability Enabled","description":"Whether the workspace's tier includes the per-member credit limit capability. When `false`, all members share the pool freely.","example":true}},"type":"object","required":["members_with_limit","members_over_limit","default_member_limit","capability_enabled"],"title":"MemberAllocationsSummary","description":"Aggregate view of per-member credit limits across the workspace."},"MemberCreditAllocation":{"properties":{"credit_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Limit","description":"Effective per-member message credit limit for the current credit reset period. `null` means no limit applies to this member.","example":1000},"credit_limit_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Limit Source","description":"Where the effective limit comes from. One of `\"user_override\"`, `\"org_default\"`, or `null` when no limit applies.","example":"org_default"},"credit_limit_used":{"type":"number","minimum":0.0,"title":"Credit Limit Used","description":"Message credits this member consumed in the current credit reset period.","example":420},"credit_limit_remaining":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Limit Remaining","description":"Member credits remaining. `null` when `credit_limit` is `null`.","example":580},"credit_limit_exceeded":{"type":"boolean","title":"Credit Limit Exceeded","description":"Whether the member has exceeded their effective per-member limit.","example":false}},"type":"object","required":["credit_limit","credit_limit_source","credit_limit_used","credit_limit_remaining","credit_limit_exceeded"],"title":"MemberCreditAllocation","description":"Per-member credit limit and usage within the shared credit pool.\n\nWhen `AnalyticsUserRecord.member_allocation` is `null`, the workspace tier\ndoes not enforce per-member credit limits, so the member draws from the pool\nwithout a personal limit."},"PaginationMetadata":{"properties":{"total":{"type":"integer","title":"Total","description":"Total number of items.","example":156},"limit":{"type":"integer","title":"Limit","description":"Number of items per page.","example":50},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Cursor for fetching the next page. The value is `null` if there are no more pages.","example":"eyJsYXN0X2lkIjoiMTIzIn0="},"has_more":{"type":"boolean","title":"Has More","description":"Whether there are more items to fetch.","example":true}},"type":"object","required":["total","limit","has_more"],"title":"PaginationMetadata","description":"Metadata for paginated responses"},"SuperAgentAnalytics":{"properties":{"superagent_id":{"type":"string","title":"Superagent Id","description":"Superagent identifier.","example":"agent_abc123"},"superagent_name":{"type":"string","title":"Superagent Name","description":"Superagent name.","example":"Support Agent"},"active_users_last_7d":{"type":"integer","minimum":0.0,"title":"Active Users Last 7D","description":"Approximate number of distinct users who sent messages to this Superagent in the last 7 days. Users who cannot be individually identified, such as users messaging through external channels, are counted as one user per conversation.","example":42},"active_users_last_30d":{"type":"integer","minimum":0.0,"title":"Active Users Last 30D","description":"Approximate number of distinct users who sent messages to this Superagent in the last 30 days. Users who cannot be individually identified, such as users messaging through external channels, are counted as one user per conversation.","example":89},"message_credits_consumed":{"type":"number","minimum":0.0,"title":"Message Credits Consumed","description":"Message credits consumed by this Superagent in the requested period.","example":4250},"integration_credits_consumed":{"type":"number","minimum":0.0,"title":"Integration Credits Consumed","description":"Integration credits consumed by this Superagent in the requested period.","example":875}},"type":"object","required":["superagent_id","superagent_name","active_users_last_7d","active_users_last_30d","message_credits_consumed","integration_credits_consumed"],"title":"SuperAgentAnalytics","description":"Detailed analytics for a specific Superagent."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WorkspaceAnalytics":{"properties":{"summary":{"$ref":"#/components/schemas/AnalyticsSummary","description":"High-level workspace summary."},"user_distribution":{"$ref":"#/components/schemas/AnalyticsUserDistribution"},"app_distribution":{"$ref":"#/components/schemas/AnalyticsAppDistribution"},"credit_pool":{"$ref":"#/components/schemas/CreditPool","description":"Workspace credit pool state for the current credit reset period."},"member_allocations":{"$ref":"#/components/schemas/MemberAllocationsSummary","description":"Aggregate view of per-member credit limits drawn from the shared pool."},"credits":{"$ref":"#/components/schemas/CreditsSummary","description":"Credits consumption summary."}},"type":"object","required":["summary","user_distribution","app_distribution","credit_pool","member_allocations","credits"],"title":"WorkspaceAnalytics","description":"Workspace analytics data."},"WorkspaceAppListItem":{"properties":{"app_id":{"type":"string","title":"App Id","description":"App identifier.","example":"app_abc123"},"app_name":{"type":"string","title":"App Name","description":"App name.","example":"Sales Dashboard"},"owner_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner User Id","description":"Current app owner user ID when known.","example":"user_abc123"},"created_by_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Email","description":"Email of the user who originally created the app.","example":"jane.doe@company.com"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"App creation date in `YYYY-MM-DDTHH:MM:SSZ` format.","example":"2025-01-10T14:30:00Z"},"last_published":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Published","description":"Last publish date in `YYYY-MM-DDTHH:MM:SSZ` format.","example":"2025-01-10T14:30:00Z"},"is_published":{"type":"boolean","title":"Is Published","description":"Whether the app has been published.","example":true},"visibility":{"type":"string","title":"Visibility","description":"App visibility, such as `\"Public\"`, `\"Public (with login)\"`, `\"Workspace\"`, or `\"Private\"`.","example":"Public (with login)"},"views_last_30d":{"type":"integer","minimum":0.0,"title":"Views Last 30D","description":"Total number of page views in the last 30 days.","example":1205},"active_users_last_30d":{"type":"integer","minimum":0.0,"title":"Active Users Last 30D","description":"Number of users who viewed the app in the last 30 days.","example":89},"message_credits_consumed":{"type":"number","minimum":0.0,"title":"Message Credits Consumed","description":"Message credits consumed by this app in the requested period.","example":4250},"integration_credits_consumed":{"type":"number","minimum":0.0,"title":"Integration Credits Consumed","description":"Integration credits consumed by this app in the requested period.","example":875},"total_credits_consumed":{"type":"number","minimum":0.0,"title":"Total Credits Consumed","description":"Combined message and integration credits consumed by this app in the requested period.","example":5125}},"type":"object","required":["app_id","app_name","is_published","visibility","views_last_30d","active_users_last_30d","message_credits_consumed","integration_credits_consumed","total_credits_consumed"],"title":"WorkspaceAppListItem","description":"Workspace app inventory row."},"WorkspaceAppListResponse":{"properties":{"apps":{"items":{"$ref":"#/components/schemas/WorkspaceAppListItem"},"type":"array","title":"Apps","description":"List of workspace apps."},"pagination":{"$ref":"#/components/schemas/PaginationMetadata","description":"Pagination metadata."}},"type":"object","required":["apps","pagination"],"title":"WorkspaceAppListResponse","description":"Paginated workspace app inventory."},"WorkspaceSuperAgentListItem":{"properties":{"superagent_id":{"type":"string","title":"Superagent Id","description":"Superagent identifier.","example":"agent_abc123"},"superagent_name":{"type":"string","title":"Superagent Name","description":"Superagent name.","example":"Support Agent"},"owner_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner User Id","description":"Current Superagent owner user ID when known.","example":"user_abc123"},"created_by_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Email","description":"Email of the user who originally created the Superagent.","example":"jane.doe@company.com"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Superagent creation date in `YYYY-MM-DDTHH:MM:SSZ` format.","example":"2025-01-10T14:30:00Z"},"active_users_last_30d":{"type":"integer","minimum":0.0,"title":"Active Users Last 30D","description":"Approximate number of distinct users who sent messages to this Superagent in the last 30 days. Users who cannot be individually identified, such as users messaging through external channels, are counted as one user per conversation.","example":89},"message_credits_consumed":{"type":"number","minimum":0.0,"title":"Message Credits Consumed","description":"Message credits consumed by this Superagent in the requested period.","example":4250},"integration_credits_consumed":{"type":"number","minimum":0.0,"title":"Integration Credits Consumed","description":"Integration credits consumed by this Superagent in the requested period.","example":875},"total_credits_consumed":{"type":"number","minimum":0.0,"title":"Total Credits Consumed","description":"Combined message and integration credits consumed by this Superagent in the requested period.","example":5125}},"type":"object","required":["superagent_id","superagent_name","active_users_last_30d","message_credits_consumed","integration_credits_consumed","total_credits_consumed"],"title":"WorkspaceSuperAgentListItem","description":"Workspace Superagent inventory row."},"WorkspaceSuperAgentListResponse":{"properties":{"superagents":{"items":{"$ref":"#/components/schemas/WorkspaceSuperAgentListItem"},"type":"array","title":"Superagents","description":"List of workspace Superagents."},"pagination":{"$ref":"#/components/schemas/PaginationMetadata","description":"Pagination metadata."}},"type":"object","required":["superagents","pagination"],"title":"WorkspaceSuperAgentListResponse","description":"Paginated workspace Superagent inventory."}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api_key","description":"API key for authentication. See the Authentication page for your API for details on how to get your key."}}},"tags":[{"name":"analytics","description":"Workspace-level analytics and KPIs including usage, engagement, and cost metrics."},{"name":"users","description":"User management, activity tracking, and credit consumption data."},{"name":"apps","description":"App-level analytics, engagement metrics, and governance flags."},{"name":"superagents","description":"Superagent inventory and analytics."}],"servers":[{"url":"https://app.base44.com/api/v1/monitoring","description":"Monitoring API"}],"security":[{"ApiKeyAuth":[]}]}