API Reference
  1. One Church Software API
  2. Metrics

Get metric comparison

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

Aggregate a metric's published values over a date range, compared against the preceding period of the same length and against the same range one year earlier.

Required permission: Full Read Metrics

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

The id of the metric to aggregate. Metric ids come from /api/reporting/metrics.

date-time
required

The start of the date range to aggregate.

date-time
required

The end of the date range to aggregate.

string

How the values in the range are aggregated: total (default), average, min, or max.

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.

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago

Did this page help you?