Skip to content

Data Owner / Settings

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

Surfmeter API – Data Owner / Settings 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 / Settings

GET /data_owner/settings

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 

{
    "settings": {
        "ai_system_prompt": "string",
        "offline_threshold_minutes": 0,
        "offline_threshold_minutes_default": 0,
        "client_offline_detection_enabled": true,
        "client_degraded_detection_enabled": true,
        "study_failure_detection_enabled": true,
        "client_offline_detection_enabled_on_server": true,
        "client_degraded_detection_enabled_on_server": true,
        "study_failure_detection_enabled_on_server": true
    }
}
⚠️ 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 settings show action",
    "type": "object",
    "required": [
        "settings"
    ],
    "properties": {
        "settings": {
            "type": "object",
            "required": [
                "ai_system_prompt",
                "offline_threshold_minutes",
                "offline_threshold_minutes_default",
                "client_offline_detection_enabled",
                "client_degraded_detection_enabled",
                "study_failure_detection_enabled",
                "client_offline_detection_enabled_on_server",
                "client_degraded_detection_enabled_on_server",
                "study_failure_detection_enabled_on_server"
            ],
            "properties": {
                "ai_system_prompt": {
                    "type": "string",
                    "nullable": true
                },
                "offline_threshold_minutes": {
                    "type": "integer",
                    "nullable": true
                },
                "offline_threshold_minutes_default": {
                    "type": "integer"
                },
                "client_offline_detection_enabled": {
                    "type": "boolean"
                },
                "client_degraded_detection_enabled": {
                    "type": "boolean"
                },
                "study_failure_detection_enabled": {
                    "type": "boolean"
                },
                "client_offline_detection_enabled_on_server": {
                    "type": "boolean"
                },
                "client_degraded_detection_enabled_on_server": {
                    "type": "boolean"
                },
                "study_failure_detection_enabled_on_server": {
                    "type": "boolean"
                }
            }
        }
    }
}

PUT /data_owner/settings

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

{
    "ai_system_prompt": "string",
    "offline_threshold_minutes": 0,
    "client_offline_detection_enabled": true,
    "client_degraded_detection_enabled": true,
    "study_failure_detection_enabled": true
}
⚠️ 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 settings update action",
    "type": "object",
    "properties": {
        "ai_system_prompt": {
            "type": "string",
            "nullable": true
        },
        "offline_threshold_minutes": {
            "type": "integer",
            "nullable": true
        },
        "client_offline_detection_enabled": {
            "type": "boolean"
        },
        "client_degraded_detection_enabled": {
            "type": "boolean"
        },
        "study_failure_detection_enabled": {
            "type": "boolean"
        }
    }
}

Response 200 OK 

{
    "settings": {
        "ai_system_prompt": "string",
        "offline_threshold_minutes": 0,
        "offline_threshold_minutes_default": 0,
        "client_offline_detection_enabled": true,
        "client_degraded_detection_enabled": true,
        "study_failure_detection_enabled": true,
        "client_offline_detection_enabled_on_server": true,
        "client_degraded_detection_enabled_on_server": true,
        "study_failure_detection_enabled_on_server": true
    }
}
⚠️ 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 settings update action",
    "type": "object",
    "required": [
        "settings"
    ],
    "properties": {
        "settings": {
            "type": "object",
            "required": [
                "ai_system_prompt",
                "offline_threshold_minutes",
                "offline_threshold_minutes_default",
                "client_offline_detection_enabled",
                "client_degraded_detection_enabled",
                "study_failure_detection_enabled",
                "client_offline_detection_enabled_on_server",
                "client_degraded_detection_enabled_on_server",
                "study_failure_detection_enabled_on_server"
            ],
            "properties": {
                "ai_system_prompt": {
                    "type": "string",
                    "nullable": true
                },
                "offline_threshold_minutes": {
                    "type": "integer",
                    "nullable": true
                },
                "offline_threshold_minutes_default": {
                    "type": "integer"
                },
                "client_offline_detection_enabled": {
                    "type": "boolean"
                },
                "client_degraded_detection_enabled": {
                    "type": "boolean"
                },
                "study_failure_detection_enabled": {
                    "type": "boolean"
                },
                "client_offline_detection_enabled_on_server": {
                    "type": "boolean"
                },
                "client_degraded_detection_enabled_on_server": {
                    "type": "boolean"
                },
                "study_failure_detection_enabled_on_server": {
                    "type": "boolean"
                }
            }
        }
    }
}

Schemas

DataOwnerSettingsShowResponse

Name Type
settings Properties: ai_system_prompt, offline_threshold_minutes, offline_threshold_minutes_default, client_offline_detection_enabled, client_degraded_detection_enabled, study_failure_detection_enabled, client_offline_detection_enabled_on_server, client_degraded_detection_enabled_on_server, study_failure_detection_enabled_on_server

DataOwnerSettingsUpdateData

Name Type
ai_system_prompt string| null
client_degraded_detection_enabled boolean
client_offline_detection_enabled boolean
offline_threshold_minutes integer| null
study_failure_detection_enabled boolean

DataOwnerSettingsUpdateResponse

Name Type
settings Properties: ai_system_prompt, offline_threshold_minutes, offline_threshold_minutes_default, client_offline_detection_enabled, client_degraded_detection_enabled, study_failure_detection_enabled, client_offline_detection_enabled_on_server, client_degraded_detection_enabled_on_server, study_failure_detection_enabled_on_server

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.