Search metric values

get

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

Retrieve the individual values recorded on finalized metric reports, matching the given filters. Values are returned by most recent report date.

Required permission: Full Read Metrics

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

metric

string

Comma-delimited list of metric ids to filter by. Values recorded for each metric's sub-metrics are included automatically. Metric ids come from /api/reporting/metrics.

date.start

date-time

Includes values from reports dated on or after this date.

date.end

date-time

Includes values from reports dated on or before this date.

value.start

double

Includes values greater than or equal to this number.

value.end

double

Includes values less than or equal to this number.

group

string

Comma-delimited list of report group ids to filter by. Matches values recorded under the group itself or any of its subgroups.

subgroup

string

Comma-delimited list of subgroup ids to filter by.

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.

200OK