modlog_summary

Get totals for the audit log instead of the entries themselves. Use it for an overview, such as “12 bans and 40 message deletions”, or to fill filter menus for modlog_get.

Request

{
  "cmd": "modlog_summary"
}

No fields besides cmd.

Response

{
  "cmd": "modlog_summary",
  "action_counts": {
    "user_moderation.user_ban": 12,
    "user_moderation.user_timeout": 9,
    "message_moderation.message_delete": 40,
    "channel_management.channel_update": 3
  },
  "category_totals": {
    "user_moderation": 21,
    "message_moderation": 40,
    "channel_management": 3
  },
  "total": 64
}

Field	Meaning
`action_counts`	Entries per action. Each key is `<category>.<action>`.
`category_totals`	Entries per category.
`total`	Every entry still in the log.

Only categories and actions that appear in the log are included. See categories and actions for the possible values.

Like modlog_get, this command deletes expired entries from storage before counting.

Permissions

Requires view_audit_log or manage_users.

Errors

`val`	When
`Modlog storage is unavailable`	The audit log file can’t be read.

See also