Skip to main content
GET
/
api
/
audit-trail
/
param-analytics
Audit Param Analytics
curl --request GET \
  --url https://api.example.com/api/audit-trail/param-analytics \
  --header 'Authorization: Bearer <token>'
{
  "totals": {
    "total_records": 0,
    "records_with_custom_params": 0,
    "applications_count": 0,
    "params_count": 0
  },
  "by_application": [
    {
      "application_id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "description": "<string>",
      "accent_color": "<string>",
      "param_count": 0,
      "usage_count": 0
    }
  ],
  "by_param": [
    {
      "schema_id": "<string>",
      "key": "<string>",
      "label": "<string>",
      "application_id": "<string>",
      "application_name": "<string>",
      "usage_count": 0,
      "distinct_values": 0,
      "top_values": [
        {
          "value": "<string>",
          "count": 123
        }
      ]
    }
  ],
  "usage_by_day": [
    {
      "date": "<string>",
      "total_records": 0,
      "custom_param_records": 0,
      "distinct_params": 0
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Query Parameters

search
string | null
event_types
string | null

Comma-separated event types

categories
string | null

Comma-separated categories

actors
string | null

Comma-separated actors

entity_type
string | null
entity_id
string | null
severities
string | null

Comma-separated severities

date_from
string<date-time> | null
date_to
string<date-time> | null
application_id
string | null
param_filters
string | null

JSON array of {key, operator, value}

Cookies

antidote_session
string | null

Response

Successful Response

totals
AuditParamAnalyticsTotals · object
required
by_application
AuditApplicationUsageSummary · object[]
by_param
AuditParamUsageSummary · object[]
usage_by_day
AuditParamTimelinePoint · object[]