Search metric reports

get

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

Retrieve the metric reports matching the given filters. Reports are returned published first, then by most recent report date.

Required permission: Full Read Metrics

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

group

string

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

subGroup

string

Comma-delimited list of subgroup ids to filter by.

date.start

date-time

Includes reports dated on or after this date.

date.end

date-time

Includes reports dated on or before this date.

finalized.start

date-time

Includes reports completed on or after this date/time.

finalized.end

date-time

Includes reports completed on or before this date/time.

started.start

date-time

Includes reports started on or after this date/time.

started.end

date-time

Includes reports started on or before this date/time.

published

boolean

Filters by whether the report has been published.

notes

string

Filters to reports whose notes contain the text.

person

int32

≥ 1

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

createdBy

string

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

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