Delete report groups

delete

https://{tenant}.onechurchsoftware.com/api/reporting/metrics/groups

Bulk delete report groups, along with their subgroups and every report submitted under them. Provide ids, or explicitly set include to false to delete every group matching the query filters (and every group outright when no filters are given); an empty body is rejected.

Required permission: Metrics Settings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Filters to groups whose name contains the text.

abbreviation

string

Filters to groups whose abbreviation contains the text.

subgroups

string

Filters to groups with a subgroup whose name contains each of the given words (space-separated).

active

boolean

Filters by whether the group is active.

count.start

double

Includes groups with at least this many submitted metric reports.

count.end

double

Includes groups with at most this many submitted metric reports.

earliest.start

date-time

Includes groups whose earliest metric report is on or after this date.

earliest.end

date-time

Includes groups whose earliest metric report is on or before this date.

latest.start

date-time

Includes groups whose most recent metric report is on or after this date.

latest.end

date-time

Includes groups whose most recent metric report is on or before this date.

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

include

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

401

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

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!