List value metrics

GET

https://api.agentpaid.io/api/v2/value-metrics/

GET

/api/v2/value-metrics/

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.valueMetrics.listValueMetrics({});
}
main();

{
  "data": [
    {
      "slug": "string",
      "name": "string",
      "category": "string",
      "unit": {
        "type": "monetary",
        "durationUnit": "seconds",
        "unit": "tickets",
        "unitDisplay": "tickets resolved"
      },
      "description": "string",
      "archivedAt": "string",
      "monetaryConversion": {
        "valuePerUnit": 1.1,
        "label": "string",
        "expression": "string",
        "variables": [
          {
            "id": "string",
            "label": "string",
            "default": 1.1
          }
        ]
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1,
    "hasMore": true
  }
}

Returns the value metrics in the current value model, without their formulas. Archived metrics are hidden unless includeArchived is true.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

includeArchivedbooleanOptional

Whether to include archived metrics in the response. Defaults to false.

Response

200

datalist of objects

paginationobject

Errors

404

Not Found Error

500

Internal Server Error