> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Merchant Overview Statistics

## 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

```bash theme={null}
curl -X GET "https://api.unibee.dev/merchant/overview_statistics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

### Sandbox

```bash theme={null}
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.


## OpenAPI

````yaml get /merchant/overview_statistics
openapi: 3.0.0
info:
  description: UniBee Api Server
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: OpenAPI UniBee
  version: daily,buildtime:202603161017
servers:
  - url: https://api.unibee.dev
  - url: https://api-sandbox.unibee.top
security:
  - Authorization: []
paths:
  /merchant/overview_statistics:
    get:
      tags:
        - Merchant
      summary: Get Merchant Overview Statistics
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties:
                      activePlansCount:
                        description: Number of active plans
                        format: int64
                        properties: {}
                        type: integer
                      paymentSuccessRate:
                        description: Payment success rate, range 0.0~1.0
                        format: float64
                        properties: {}
                        type: number
                      successfulPaymentsCount:
                        description: Successful payments count
                        format: int64
                        properties: {}
                        type: integer
                      totalCustomersCount:
                        description: Total customers count
                        format: int64
                        properties: {}
                        type: integer
                    type: object
                  merchantId:
                    format: int64
                    properties: {}
                    type: integer
                  message:
                    format: string
                    properties: {}
                    type: string
                  redirect:
                    format: string
                    properties: {}
                    type: string
                  requestId:
                    format: string
                    properties: {}
                    type: string
                type: object
          description: ''
components:
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````