Get metric chart

get

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

Aggregate a metric's published values into chart-ready buckets over a date range, with one series per top-level report group by default.

Required permission: Full Read Metrics

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

metric

string

required

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

start

date-time

required

The start of the date range to chart.

end

date-time

required

The end of the date range to chart.

precision

string

The size of each chart bucket: day, week, month (default), quarter, or year.

chartType

string

The chart the data is shaped for: bar (default), line, or pie. Previous-year comparison and combining report groups only apply to bar and line.

reportGroupIds

string

The ids of the top-level report groups to include. All active groups are included when omitted.

includePreviousYear

boolean

Whether to return a previous-year series alongside the current one for comparison. Combines all report groups into one series.

combineReportGroups

boolean

Whether to combine all report groups into a single total series instead of one series per group.

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