Delete metric reports

Bulk delete metric reports and their recorded values. Provide ids, or explicitly set include to false to delete every report matching the query filters (and every report outright when no filters are given); an empty body is rejected. Without full metrics write access, deleting by ids fails when a published report is included, and criteria-based deletes skip published reports. Deleting a published report requires the Full Write Metrics permission.

Required permission: Limited Write Metrics

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Comma-delimited list of top-level report group ids to filter by.

string

Comma-delimited list of subgroup ids to filter by.

date-time

Includes reports dated on or after this date.

date-time

Includes reports dated on or before this date.

date-time

Includes reports completed on or after this date/time.

date-time

Includes reports completed on or before this date/time.

date-time

Includes reports started on or after this date/time.

date-time

Includes reports started on or before this date/time.

boolean

Filters by whether the report has been published.

string

Filters to reports whose notes contain the text.

int32
≥ 1

Filters by the id of the person who completed the report.

string

Filters to reports started by a user whose name contains the text.

Body Params

The ids to delete

ids
array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids
boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!