Gets the overview Sell Dashboar

Calculate the metric overview dashboard for the payments.

get

Query parameters

testModebooleanOptional

Query parameter to enable the test mode.

Default: false

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/payments/dashboard HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "totalSells": 500,
    "totalRevenue": 2.3,
    "dailySells": 0.1,
    "dailyRevenue": 0.5
  },
  "errors": []
}