search

Insights Audit Logs

API endpoints for audit logging operations related to insights KPIs, dashboards, and tool mappings.

Learn more about Audit Logging.arrow-up-right

hashtag
Get recently viewed dashboards for the current user

get

Retrieves a list of dashboards that were recently viewed by the current user, ordered by most recent view time. This endpoint retrieves dashboard view history from the viewlogs collection, providing insights into recent user engagement patterns.

hashtag
Use Cases

  • Display recently viewed dashboards in user interfaces for quick access

  • Track user engagement with dashboards over time

  • Understand recent user engagement patterns and dashboard activity trends

  • Provide personalized dashboard recommendations based on viewing history

hashtag
Required Access

  • API Scope: api or api-readonly

  • Site Roles: Opsera Administrator, Administrator, Power User, Users

Authorizations
AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Responses
chevron-right
200

Successfully retrieved recently viewed dashboards

application/json
dataobject[]Optional

Array of recently viewed dashboard objects, ordered by most recent view time

messagestringOptional

Success message

Example: Successfully retrieved recently viewed dashboards
get
/api/v2/insights/kpis/audit-logs/dashboard/recently-viewed

hashtag
Get most viewed dashboards across all users

get

Retrieves a list of dashboards ordered by total view count across all users from the viewlogs collection, showing the most frequently accessed dashboards in the system. This endpoint provides aggregate statistics on dashboard popularity and helps identify the most valuable or commonly used dashboards.

hashtag
Use Cases

  • Identify popular and trending dashboards across the organization

  • Analyze dashboard usage trends and patterns

  • Display most viewed dashboards in user interfaces

  • Understand which dashboards provide the most value to users

hashtag
Required Access

  • API Scope: api or api-readonly

  • Site Roles: Opsera Administrator, Administrator, Power User, Users

Authorizations
AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Responses
chevron-right
200

Successfully retrieved most viewed dashboards

application/json
dataobject[]Optional

Array of most viewed dashboard objects, ordered by total view count

messagestringOptional

Success message

Example: Successfully retrieved most viewed dashboards
get
/api/v2/insights/kpis/audit-logs/dashboard/most-viewed

hashtag
Get view statistics for a specific dashboard

get

Retrieves aggregated view statistics for a specific dashboard, including view counts, engagement metrics, and usage patterns. This endpoint provides comprehensive analytics on dashboard performance and user engagement from the audit log data.

hashtag
Use Cases

  • Analyze dashboard engagement metrics and performance

  • Track dashboard usage statistics and view counts

  • Generate reports on dashboard activity and popularity

  • Understand dashboard value and user adoption patterns

hashtag
Required Access

  • API Scope: api or api-readonly

  • Site Roles: Opsera Administrator, Administrator, Power User, Users

Authorizations
AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters
dashboardIdstring · uuidRequired

Unique identifier of the dashboard in UUID format

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Successfully retrieved dashboard view statistics

application/json
dataobjectOptional

Dashboard statistics object containing view counts and engagement metrics

messagestringOptional

Success message

Example: Successfully retrieved dashboard audit logs stats
get
/api/v2/insights/kpis/audit-logs/dashboard/{dashboardId}/stats

hashtag
Log dashboard view - stores current time and increments view count

post

Records a dashboard view event for a specific dashboard. This endpoint stores the current timestamp and increments the view count in the audit log system. The view event is logged in the user activity collection, enabling analytics and usage tracking for dashboards.

hashtag
Use Cases

  • Track dashboard views for analytics and reporting

  • Monitor user engagement with dashboards in real-time

  • Generate usage reports and metrics based on view events

  • Enable dashboard popularity and trending calculations

hashtag
Required Access

  • API Scope: api

  • Site Roles: Opsera Administrator, Administrator, Power User, Users

Authorizations
AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters
dashboardIdstring · uuidRequired

Unique identifier of the dashboard in UUID format

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Dashboard view event recorded successfully

application/json
dataobjectOptional

View event data including timestamp and updated view count

messagestringOptional

Success message

Example: Successfully recorded dashboard view
post
/api/v2/insights/kpis/audit-logs/dashboard/{dashboardId}/view

hashtag
Get user activity audit logs for a specific dashboard ID

get

Retrieves all user activity audit log entries related to a specific dashboard from the user activity collection. This includes view events, access records, timestamps, and other audit trail information for the dashboard, providing a complete history of dashboard interactions.

hashtag
Use Cases

  • Review dashboard access history and user interactions

  • Audit dashboard usage and access patterns over time

  • Investigate dashboard-related activities and user behavior

  • Generate comprehensive reports on dashboard engagement

hashtag
Required Access

  • API Scope: api or api-readonly

  • Site Roles: Opsera Administrator, Administrator, Power User, Users

Authorizations
AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters
dashboardIdstring · uuidRequired

Unique identifier of the dashboard in UUID format

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Successfully retrieved dashboard audit logs

application/json
dataobject[]Optional

Array of user activity audit log entries for the dashboard

messagestringOptional

Success message

Example: Successfully retrieved dashboard audit logs
get
/api/v2/insights/kpis/audit-logs/dashboard/{dashboardId}

hashtag
Get user activity audit logs for a specific mapping ID

get

Retrieves all user activity audit log entries related to a specific tool mapping from the user activity collection. This includes events related to the mapping's usage, modifications, access patterns, and other interactions with the mapping.

hashtag
Use Cases

  • Review tool mapping access history and usage patterns

  • Audit tool mapping interactions and modifications

  • Investigate mapping-related activities and user behavior

  • Track mapping utilization and engagement metrics

hashtag
Required Access

  • API Scope: api or api-readonly

  • Site Roles: Opsera Administrator, Administrator, Power User, Users

Authorizations
AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters
mappingIdstring · uuidRequired

Unique identifier of the tool mapping in UUID format

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Successfully retrieved mapping audit logs

application/json
dataobject[]Optional

Array of user activity audit log entries for the mapping

messagestringOptional

Success message

Example: Successfully retrieved mapping audit logs
get
/api/v2/insights/kpis/audit-logs/mapping/{mappingId}

hashtag
Get audit log by ID from user activity collection

get

Retrieves a specific audit log entry by its unique identifier from the user activity collection. This endpoint provides detailed information about a single audit log event, including timestamps, user information, event details, and all associated metadata.

hashtag
Use Cases

  • Retrieve detailed information about a specific audit log entry

  • Investigate specific events or incidents with complete context

  • Access complete audit trail information for compliance and auditing

  • Debug and troubleshoot user activity issues

hashtag
Required Access

  • API Scope: api or api-readonly

  • Site Roles: Opsera Administrator, Administrator, Power User, Users

Authorizations
AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters
idstringRequired

Unique identifier of the audit log entry from the user activity collection

Example: 507f1f77bcf86cd799439011
Responses
chevron-right
200

Successfully retrieved audit log

application/json
dataobjectOptional

Audit log entry object with detailed information including timestamps, user info, and event details

messagestringOptional

Success message

Example: Successfully retrieved audit log
get
/api/v2/insights/kpis/audit-logs/{id}
PreviousUser ManagementNextLineaje

Last updated