> ## 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. # New Merchant Metric ## Endpoint Overview **POST** `https://api.unibee.dev/merchant/metric/new` New Merchant Metric *** ## Authorization All UniBee Merchant API requests require authentication via API key. | Header | Required | Description | | --------------- | -------- | ------------------------------------- | | `Authorization` | Yes | Bearer `` | | `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. ### Request body | Name | Type | Required | Description | | --------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------ | | `aggregationProperty` | string | No | AggregationProperty, Will Needed When AggregationType != count | | `aggregationType` | integer | No | AggregationType,1-count，2-count unique, 3-latest, 4-max, 5-sum | | `carryoverProrationEnabled` | boolean | No | Enable carryover proration for this metric (default: false when not set) | | `code` | string | Yes | Code | | `metaData` | object | No | meta\_data(json) | | `metricDescription` | string | No | MetricDescription | | `metricName` | string | Yes | MetricName | | `prorationRefundEnabled` | boolean | No | Enable proration refund for this metric (reclaim metric limit on upgrade; default: false when not set) | | `type` | integer | No | 1-limit\_metered，2-charge\_metered，3-charge\_recurring，4-limit\_recurring | | `unit` | string | No | unit | *** ## Request examples ### cURL ```bash theme={null} curl -X POST "https://api.unibee.dev/merchant/metric/new" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "aggregationProperty": "", "aggregationType": 0, "carryoverProrationEnabled": false, "code": "", "metaData": {}, "metricDescription": "", "metricName": "", "prorationRefundEnabled": false, "type": 0, "unit": "" }' ``` ### Sandbox ```bash theme={null} curl -X POST "https://api-sandbox.unibee.top/merchant/metric/new" \ -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "aggregationProperty": "", "aggregationType": 0, "carryoverProrationEnabled": false, "code": "", "metaData": {}, "metricDescription": "", "metricName": "", "prorationRefundEnabled": false, "type": 0, "unit": "" }' ``` *** ## 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.merchantMetric` | object | | | `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 post /merchant/metric/new 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/new: post: tags: - Metric summary: New Merchant Metric requestBody: content: application/json: schema: $ref: '#/components/schemas/unibee.api.merchant.metric.NewReq' required: true responses: '200': content: application/json: schema: properties: code: format: int properties: {} type: integer data: properties: merchantMetric: $ref: '#/components/schemas/unibee.api.bean.MerchantMetric' 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.merchant.metric.NewReq: properties: aggregationProperty: description: AggregationProperty, Will Needed When AggregationType != count format: string properties: {} type: string aggregationType: description: AggregationType,1-count，2-count unique, 3-latest, 4-max, 5-sum format: int properties: {} type: integer carryoverProrationEnabled: description: >- Enable carryover proration for this metric (default: false when not set) format: '*bool' properties: {} type: boolean code: description: Code format: string properties: {} type: string metaData: additionalProperties: $ref: '#/components/schemas/interface' description: meta_data(json) format: map[string]interface {} properties: {} type: object metricDescription: description: MetricDescription format: string properties: {} type: string metricName: description: MetricName format: string properties: {} type: string prorationRefundEnabled: description: >- Enable proration refund for this metric (reclaim metric limit on upgrade; default: false when not set) format: '*bool' properties: {} type: boolean type: description: >- 1-limit_metered，2-charge_metered，3-charge_recurring，4-limit_recurring format: '*int' properties: {} type: integer unit: description: unit format: string properties: {} type: string required: - code - metricName type: object 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 ````