Retrieve Metrics Settings

Retrieves the metrics settings of the project

HTTP Request

GET/api/settings/metrics

Authorization

Authorization

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

Example Requests

🐍 Python

1import requests
2
3# Retrieve metrics settings
4response = requests.get('http://www.example.com/api/settings/metrics', 
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())

🌐 Curl

1# Retrieve metrics settings
2curl "http://www.example.com/api/settings/metrics" -H "Authorization: Token <your_api_key>"

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
}