Skip to content

DELETE /measurements/{msm}/

Stop a running measurement. Sending a DELETE http verb to the API will stop the measurement. You can only stop measurements that belong to the current logged in user, or by passing in a key query parameter with a key that has permissions to stop a measurement.

DELETE /measurements/{msm}/ — fields

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

DELETE /measurements/{msm}/ — format[datetime]

Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix' or 'timestamp')

DELETE /measurements/{msm}/ — msm

The unique measurement ID.

DELETE /measurements/{msm}/ — optional_fields

Comma-separated list of optional fields named to include in response objects.

DELETE /api/v2/measurements/{msm}/

Stop a running measurement.

Sending a DELETE http verb to the API will stop the measurement. You can only stop measurements that belong to the current logged in user, or by passing in a key query parameter with a key that has permissions to stop a measurement.

Try it out

Playground

Authorization
Variables
Key
Value
Authorizations

Authorizations

api-key
Type
API Key (header: Authorization)
or
session
Type
API Key (cookie: atlasess)
Parameters

Path Parameters

msm*

The unique measurement ID.

Type
integer
Required

Query Parameters

fields

Comma-separated list of fields to include in response, in addition to 'type' and 'id' which are always present. Optional fields can be listed here also.

Type
string
format[datetime]

Output datetimes in ISO-8601 format ('iso-8601' or 'json') or as seconds since the epoch ('unix' or 'timestamp')

Type
string
Valid values
"iso-8601""json""timestamp""unix"
optional_fields

Comma-separated list of optional fields named to include in response objects.

Type
string
Valid values
"participation_requests""participant_logs""current_probes""is_active""probe_sources""probes"
Responses

Responses

No response body

Samples