Update Metrics Settings

Updates the metrics settings of the platform.

HTTP Request

PATCH/api/settings/metrics

Authorization

Authorization

• Required: Yes
• Permission: Staff or Admin
• 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 exclude from tracking (max 1000 chars when stored as text)
metrics_excluded_routes	Array[String]	No	List of routes to exclude from tracking (max 1000 chars when stored as text)

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}'

Status Codes

Code	Description
200	Request logs retrieved successfully
400	Bad request — invalid query parameters
401	Unauthorized — authentication required
403	Forbidden — insufficient permissions
500	Internal server error

Response Fields

Field	Type	Description
metrics_tracking_enabled	Boolean	Enable metrics tracking (default: true)
metrics_excluded_fields	Array[String]	List of fields to exclude from tracking (max 1000 chars when stored as text)
metrics_excluded_routes	Array[String]	List of routes to exclude from tracking (max 1000 chars when stored as text)