Search report groups

get

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

Retrieve the top-level report groups that metric reports are submitted under, with their active subgroups nested. Groups are returned in name order.

Required permission: Full Read Metrics

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.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

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! Or choose an example:

text/plain

application/json

text/json

200OK