/
Retrieve dashboard data

Retrieve dashboard data
Experimental

Request

Retrieves dashboard data.

Security
SecretApiKey or JWT
Query
periodStartstring, (date-time)

Date and time when the report starts. Defaults to the start of the current month.

periodEndstring, (date-time)

Date and time when the report ends. Defaults to the end of the current month.

metricsstring

Comma-separated list of metrics.

segmentsstring

Dashboard report segments as a JSON array.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/dashboard?periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&metrics=string&segments=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Bodyapplication/json
Array [
metricstring(DashboardMetric)

Type of dashboard metric.

Enum:"approvalRate""salesCount""salesValue""refundsValue""chargebacksCount""chargebacksValue""transactionsCount""redeemedCouponsCount""newLeadsCount""newCustomersCount"
humanNamestring

Display name of the metric.

increaseIsGoodboolean

Specifies whether a higher value is a positive result for the merchant.

segmentsArray of objects

Segment data.

]
Response
[
  {
    "metric": "approvalRate",
    "humanName": "string",
    "increaseIsGood": true,
    "segments": [ … ]
  }
]