# Retrieve dashboard data

Retrieves dashboard data.

Endpoint: GET /experimental/reports/dashboard
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `periodStart` (string, required)
    Date and time when the report starts.

  - `periodEnd` (string, required)
    Date and time when the report ends.

  - `metrics` (string)
    Comma-separated list of metrics.

  - `segments` (string)
    Dashboard report segments as a JSON array.

## Response 200 fields (application/json):

  - `metric` (string)
    Type of metric.
    Enum: "approvalRate", "salesCount", "salesValue", "refundsValue", "chargebacksCount", "chargebacksValue", "transactionsCount", "redeemedCouponsCount", "newLeadsCount", "newCustomersCount", "appliedCouponsCount", "trialConversionsCount", "trialConversionsRate", "renewalSuccessRate", "renewalsCount", "newTrialsCount", "reactivationsCount", "successfulRetriesCount", "invoicedRevenue", "churnCount", "churnRate", "cancellationsCount", "cancellationsRate", "activeSubscriptionsCount", "newSubscriptionsCount", "upgradesCount", "downgradesCount", "monthlyRecurringRevenue", "annualRecurringRevenue", "averageRevenuePerCustomer", "customerLifetimeValue", "addressProofAcceptanceRate", "identityProofAcceptanceRate", "fundsProofAcceptanceRate", "purchaseProofAcceptanceRate", "creditFileProofAcceptanceRate", "kycRejectionRate", "kycAccuracyRate", "addressProofAccuracyRate", "identityProofAccuracyRate", "creditFileProofAccuracyRate", "kycRequestCount", "kycRequestAbandonmentRate", "kycRequestAttemptedRate", "kycRequestFailureRate", "kycRequestFulfillmentRate", "kycRequestExpirationRate"

  - `humanName` (string)
    Display name of the metric.

  - `increaseIsGood` (boolean)
    Specifies whether a higher value is a positive result for the merchant.

  - `segments` (array)
    Segment data.

  - `segments.name` (string)
    Name of the segment.

  - `segments.value` (number,null)
    Segment value for the specified date range.

  - `segments.previousValue` (number,null)
    Segment value for the previous date range.
This value is relative to the specified date range.

  - `segments.humanValue` (string,null)
    Human readable segment value.
This field is formatted with a currency sign.

  - `segments.changeRatio` (number,null)
    Ratio of the current value for each previous value.
A null value represents infinity.

  - `segments.humanChangeRatio` (string,null)
    Human readable change ratio.
This field is formatted percentage sign.
A null value represents infinity.

  - `segments.timeseries` (array)
    Time series.

  - `segments.timeseries.date` (string)
    Entry date-time.

  - `segments.timeseries.value` (number,null)
    Entry value.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.