activityLogAnalytics

Requires permission audit:activity_log:read.

Returns activity log totals for the organization: events today, active users, and counts by action, record type and user, optionally for a filtered set. Requires permission to read the activity log.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ActivityLogAnalytics {
  activityLogAnalytics {
    activeActors
    eventsToday
    totalEvents
    byAction {
      count
      key
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ActivityLogAnalytics {\n  activityLogAnalytics {\n    activeActors\n    eventsToday\n    totalEvents\n    byAction {\n      count\n      key\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "activityLogAnalytics": {
      "activeActors": 0,
      "eventsToday": 0,
      "totalEvents": 0,
      "byAction": [
        {
          "count": 0,
          "key": "string"
        }
      ]
    }
  }
}

activityLogAnalytics(
  filter: ActivityLogFilterInput
): ActivityLogAnalytics!

Arguments

activityLogAnalytics.filter ● ActivityLogFilterInput input

Optional filters. The same ones as activityLogs.

Type

ActivityLogAnalytics object

Figures about the activity log.