Data Owner / Anomaly Detection Config¶

Reference for the data_owner/anomaly_detection_config endpoints of the Surfmeter API.

Surfmeter API – Data Owner / Anomaly Detection Config v1¶

The Surfmeter API lets you manage clients, users, capabilities, measurements, and organization-wide settings programmatically.

Servers¶

Description	URL
https://surfmeter-server.{host}/client_admin_api/v1	https://surfmeter-server.{host}/client_admin_api/v1

Data Owner / Anomaly Detection Config¶

GET /data_owner/anomaly_detection_config¶

Input parameters

Parameter	In	Type	Default	Nullable	Description
`ApiKeyAuth`	header	string	N/A	No	API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys.

Response 200 OK

application/json

{
    "anomaly_detection_config": {
        "enabled": true,
        "bootstrap_status": "bootstrapping",
        "sensitivity": "low",
        "sensitivities": [
            "string"
        ]
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Response for data owner anomaly detection config show action",
    "type": "object",
    "required": [
        "anomaly_detection_config"
    ],
    "properties": {
        "anomaly_detection_config": {
            "type": "object",
            "required": [
                "enabled",
                "sensitivity",
                "sensitivities"
            ],
            "properties": {
                "enabled": {
                    "type": "boolean",
                    "description": "Whether anomaly detection is active for this data owner."
                },
                "bootstrap_status": {
                    "type": "string",
                    "enum": [
                        "bootstrapping",
                        "active",
                        null
                    ],
                    "description": "Bootstrap phase of the detector. Null when not yet initialized.",
                    "nullable": true
                },
                "sensitivity": {
                    "type": "string",
                    "enum": [
                        "low",
                        "medium",
                        "high"
                    ],
                    "description": "Global detection sensitivity. Defaults to medium when unset."
                },
                "sensitivities": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "Available sensitivity values for the settings selector."
                }
            }
        }
    }
}

PUT /data_owner/anomaly_detection_config¶

Input parameters

Parameter	In	Type	Default	Nullable	Description
`ApiKeyAuth`	header	string	N/A	No	API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys.

Request body

application/json

{
    "sensitivity": "low"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Request data for data owner anomaly detection config update action",
    "type": "object",
    "required": [
        "sensitivity"
    ],
    "properties": {
        "sensitivity": {
            "type": "string",
            "enum": [
                "low",
                "medium",
                "high"
            ],
            "description": "Global detection sensitivity to set."
        }
    }
}

Response 200 OK

application/json

{
    "anomaly_detection_config": {
        "enabled": true,
        "bootstrap_status": "bootstrapping",
        "sensitivity": "low",
        "sensitivities": [
            "string"
        ]
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Response for data owner anomaly detection config update action",
    "type": "object",
    "required": [
        "anomaly_detection_config"
    ],
    "properties": {
        "anomaly_detection_config": {
            "type": "object",
            "required": [
                "enabled",
                "sensitivity",
                "sensitivities"
            ],
            "properties": {
                "enabled": {
                    "type": "boolean",
                    "description": "Whether anomaly detection is active for this data owner."
                },
                "bootstrap_status": {
                    "type": "string",
                    "enum": [
                        "bootstrapping",
                        "active",
                        null
                    ],
                    "description": "Bootstrap phase of the detector. Null when not yet initialized.",
                    "nullable": true
                },
                "sensitivity": {
                    "type": "string",
                    "enum": [
                        "low",
                        "medium",
                        "high"
                    ],
                    "description": "Global detection sensitivity. Defaults to medium when unset."
                },
                "sensitivities": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "Available sensitivity values for the settings selector."
                }
            }
        }
    }
}

Schemas¶

AnomalyDetectionConfigShowResponse¶

Name	Type
`anomaly_detection_config`	Properties: `enabled, bootstrap_status, sensitivity, sensitivities`

AnomalyDetectionConfigUpdateData¶

Name	Type
`sensitivity`	string

AnomalyDetectionConfigUpdateResponse¶

Name	Type
`anomaly_detection_config`	Properties: `enabled, bootstrap_status, sensitivity, sensitivities`

Security schemes¶

Name	Type	Scheme	Description
ApiKeyAuth	apiKey		API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys.