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

## Endpoint Overview

**GET** `https://api.unibee.dev/merchant/metric/list`

Get Merchant Metric list

***

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

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

### Query parameters

| Name              | Type    | Required | Description                                    |
| ----------------- | ------- | -------- | ---------------------------------------------- |
| `searchKey`       | string  | No       | Search Key, code or name                       |
| `sortField`       | string  | No       | Sort，user\_id\|gmt\_create，Default gmt\_create |
| `sortType`        | string  | No       | Sort Type，asc\|desc，Default desc               |
| `page`            | integer | No       | Page,Start 0                                   |
| `count`           | integer | No       | Count OF Page                                  |
| `createTimeStart` | integer | No       | CreateTimeStart，UTC timestamp，seconds          |
| `createTimeEnd`   | integer | No       | CreateTimeEnd，UTC timestamp，seconds            |

***

## Request examples

### cURL

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

### Sandbox

```bash theme={null}
curl -X GET "https://api-sandbox.unibee.top/merchant/metric/list" \
  -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.merchantMetrics` | array   | MerchantMetrics              |
| `data.total`           | integer | Total                        |
| `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/metric/list
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/metric/list:
    get:
      tags:
        - Metric
      summary: Get Merchant Metric list
      parameters:
        - description: Search Key, code or name
          in: query
          name: searchKey
          schema:
            description: Search Key, code or name
            format: string
            properties: {}
            type: string
        - description: Sort，user_id|gmt_create，Default gmt_create
          in: query
          name: sortField
          schema:
            description: Sort，user_id|gmt_create，Default gmt_create
            format: string
            properties: {}
            type: string
        - description: Sort Type，asc|desc，Default desc
          in: query
          name: sortType
          schema:
            description: Sort Type，asc|desc，Default desc
            format: string
            properties: {}
            type: string
        - description: Page,Start 0
          in: query
          name: page
          schema:
            description: Page,Start 0
            format: int
            properties: {}
            type: integer
        - description: Count OF Page
          in: query
          name: count
          schema:
            description: Count OF Page
            format: int
            properties: {}
            type: integer
        - description: CreateTimeStart，UTC timestamp，seconds
          in: query
          name: createTimeStart
          schema:
            description: CreateTimeStart，UTC timestamp，seconds
            format: int64
            properties: {}
            type: integer
        - description: CreateTimeEnd，UTC timestamp，seconds
          in: query
          name: createTimeEnd
          schema:
            description: CreateTimeEnd，UTC timestamp，seconds
            format: int64
            properties: {}
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties:
                      merchantMetrics:
                        description: MerchantMetrics
                        format: '[]*bean.MerchantMetric'
                        items:
                          $ref: '#/components/schemas/unibee.api.bean.MerchantMetric'
                        properties: {}
                        type: array
                      total:
                        description: Total
                        format: int
                        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:
  schemas:
    unibee.api.bean.MerchantMetric:
      properties:
        aggregationProperty:
          description: aggregation property
          format: string
          properties: {}
          type: string
        aggregationType:
          description: 1-count，2-count unique, 3-latest, 4-max, 5-sum
          format: int
          properties: {}
          type: integer
        archived:
          description: archived
          format: bool
          properties: {}
          type: boolean
        carryoverProrationEnabled:
          description: Enable carryover proration for this metric (false when not set)
          format: bool
          properties: {}
          type: boolean
        code:
          description: code
          format: string
          properties: {}
          type: string
        createTime:
          description: create utc time
          format: int64
          properties: {}
          type: integer
        gmtModify:
          description: update time
          format: int64
          properties: {}
          type: integer
        id:
          description: id
          format: int64
          properties: {}
          type: integer
        merchantId:
          description: merchantId
          format: int64
          properties: {}
          type: integer
        metaData:
          additionalProperties:
            $ref: '#/components/schemas/interface'
          description: meta_data(json)
          format: map[string]interface {}
          properties: {}
          type: object
        metricDescription:
          description: metric description
          format: string
          properties: {}
          type: string
        metricName:
          description: metric name
          format: string
          properties: {}
          type: string
        prorationRefundEnabled:
          description: >-
            Enable proration refund for this metric, i.e. reclaim metric limit
            on upgrade (false when not set)
          format: bool
          properties: {}
          type: boolean
        type:
          description: 1-limit_metered，2-charge_metered,3-charge_recurring
          format: int
          properties: {}
          type: integer
        unit:
          description: unit
          format: string
          properties: {}
          type: string
      type: object
    interface:
      properties: {}
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````