Retrieve dashboard data

Retrieve dashboard data.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string <date-time>

Report start day.

periodEnd
required
string <date-time>

Report end day.

metrics
string <date-time>

Comma-separated list of metrics.

segments
string

Dashboard report segments as a JSON array.

Responses
200

Report was retrieved successfully.

Response Schema: application/json
Array
metric
string

Metric type.

Enum: "approvalRate" "salesCount" "salesValue" "refundsValue" "chargebacksCount" "chargebacksValue" "transactionsCount" "redeemedCouponsCount" "newLeadsCount" "newCustomersCount" … 36 more
humanName
string

Metric name to display.

increaseIsGood
boolean

True when the higher value means a better performance thus positive for a merchant, false otherwise.

Array of objects
Array
name
string

Segment name.

value
number or null <double>

Segment value for the given date range.

previousValue
number or null <double>

Segment value for the previous date range (relative to the given date range).

humanValue
string or null

Human readable segment value (formatted with a currency sign).

changeRatio
number or null <double>

Ratio of current value per previous value null is infinity.

humanChangeRatio
string or null

Human readable change ratio (formatted percentage with a "%" sign), null is infinity.

Array of objects
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/dashboard
Request samples
Response samples
application/json
[
  • {
    }
]