/
Retrieve dashboard metric...

Retrieve dashboard metric data
Experimental

Request

Retrieves the report data for a single dashboard metric.

Security
SecretApiKey or JWT
Path
metricstring(DashboardMetric)required

Name of the dashboard metric.

Enum:"approvalRate""salesCount""salesValue""refundsValue""chargebacksCount""chargebacksValue""transactionsCount""redeemedCouponsCount""newLeadsCount""newCustomersCount"
Query
periodStartstring, (date-time)required

Start date and time of the metric range. The interval between periodStart and periodEnd must not exceed 100 days.

Example:periodStart=2024-01-01T00:00:00Z
periodEndstring, (date-time)required

End date and time of the metric range. The interval between periodStart and periodEnd must not exceed 100 days.

Example:periodEnd=2024-01-31T23:59:59Z
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/profile/dashboard/metrics/{metric}?periodStart=2024-01-01T00%3A00%3A00Z&periodEnd=2024-01-31T23%3A59%3A59Z' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Metric report retrieved.

Bodyapplication/json
metricstring(DashboardMetric)

Type of dashboard metric.

Enum:"approvalRate""salesCount""salesValue""refundsValue""chargebacksCount""chargebacksValue""transactionsCount""redeemedCouponsCount""newLeadsCount""newCustomersCount"
valuenumber or null, (double)

Tile value for the specified date range.

previousValuenumber or null, (double)

Tile value for the previous date range. This value is relative to the specified date range.

timeseriesArray of objects, <= 100 items

Time series of tile values across the specified date range.

Response
{
  "metric": "approvalRate",
  "value": 0,
  "previousValue": 0,
  "timeseries": [
    { … }
  ]
}