Get Merchant Overview Statistics

GET /merchant/overview_statistics

Get Merchant Overview Statistics

cURL

curl --request GET \
  --url https://api.unibee.dev/merchant/overview_statistics \
  --header 'Authorization: Bearer <token>'

200

{
  "code": 123,
  "data": {
    "activePlansCount": 123,
    "paymentSuccessRate": 123,
    "successfulPaymentsCount": 123,
    "totalCustomersCount": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

GET https://api.unibee.dev/merchant/overview_statistics

Get Merchant Overview Statistics

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure.

Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure.

---

Request examples

cURL

curl -X GET "https://api.unibee.dev/merchant/overview_statistics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/overview_statistics" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
code	integer	Response code. 0 = success
data	object	Response payload
data.activePlansCount	integer	Number of active plans
data.paymentSuccessRate	number	Payment success rate, range 0.0~1.0
data.successfulPaymentsCount	integer	Successful payments count
data.totalCustomersCount	integer	Total customers count
message	string	Human-readable message
requestId	string	Request ID for support

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>