Measurement Options¶

Reference for the measurement_options endpoints of the Surfmeter API.

Surfmeter API – Measurement Options 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

Measurement Options¶

GET /measurement_options¶

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

{
    "measurement_types": [
        "string"
    ],
    "measurement_subjects": {}
}

⚠️ 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

{
    "type": "object",
    "properties": {
        "measurement_types": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "measurement_subjects": {
            "type": "object",
            "additionalProperties": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            }
        }
    },
    "required": [
        "measurement_types",
        "measurement_subjects"
    ]
}

Schemas¶

MeasurementOptionsIndexResponse¶

Name	Type
`measurement_subjects`
`measurement_types`	Array<string>

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.