Update Metrics Settings

Updates the metrics settings of the project

HTTP Request

PATCH/api/settings/metrics

Authorization

Authorization

• Required: Yes
• Permission: Staff with MetricsSettingsPermission or Admin
• Permission Code: 1052
• Authentication: Token authentication

Request Body

Field	Type	Required	Description
metrics_tracking_enabled	Boolean	No	Enable metrics tracking (default: true)
metrics_excluded_fields	Array[String]	No	List of fields to be excluded from tracking
metrics_excluded_routes	Array[String]	No	List of routes to be excluded from tracking

Example Requests

🐍 Python

1import requests
2
3# Update metrics settings
4response = requests.patch('http://www.example.com/api/settings/metrics', 
5  headers={'Authorization': 'Token <your_api_key>'},
6  json={
7      "metrics_tracking_enabled": false,
8      "metrics_excluded_fields": ["field1", "field2"],
9      "metrics_excluded_routes": ["/api/v1/route1", "/api/v1/route2"]
10  }
11)
12print(response.json())

🌐 Curl

1# Update metrics settings
2curl "http://www.example.com/api/settings/metrics" -H "Authorization: Token <your_api_key>" -X PATCH -d '{
3  "metrics_tracking_enabled": false,
4  "metrics_excluded_fields": ["field1", "field2"],
5  "metrics_excluded_routes": ["/api/v1/route1", "/api/v1/route2"]
6}'

Response Fields

Field	Type	Description
metrics_tracking_enabled	Boolean	Enable metrics tracking (default: true)
metrics_excluded_fields	Array[String]	List of fields to be excluded from tracking
metrics_excluded_routes	Array[String]	List of routes to be excluded from tracking

Example Response

{
    "metrics_excluded_fields": [
        "exception_traceback",
        "response_headers"
    ],
    "metrics_excluded_routes": [
        "/route_one",
        "/reoute_two"
    ],
    "metrics_tracking_enabled": false
}

Notes

• Current available fields: user, ip, device, device_type, is_bot, os, browser, scheme, endpoint, method, query_params, body, status_code, response, request_headers, response_headers, exception_type, exception_message, exception_traceback