Get a value metric

GET

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

GET

/api/v2/value-metrics/:slug

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

{
  "slug": "string",
  "name": "string",
  "category": "string",
  "unit": {
    "type": "monetary",
    "durationUnit": "seconds",
    "unit": "tickets",
    "unitDisplay": "tickets resolved"
  },
  "description": "string",
  "longDescription": "string",
  "sources": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "archivedAt": "string",
  "monetaryConversion": {
    "valuePerUnit": 1.1,
    "label": "string",
    "expression": "string",
    "variables": [
      {
        "id": "string",
        "label": "string",
        "default": 1.1
      }
    ]
  },
  "formula": {
    "id": "string",
    "label": "string",
    "expression": "string",
    "variables": [
      {
        "id": "string",
        "label": "string",
        "type": "number",
        "description": "string",
        "format": "percent",
        "formatUnit": "seconds"
      }
    ]
  },
  "signals": [
    {
      "eventName": "ticket_resolved",
      "label": "string",
      "defaults": {},
      "description": "string",
      "labels": [
        "string"
      ],
      "tags": [
        "string"
      ]
    }
  ]
}

Returns one value metric with its formula, signal binding and monetary conversion joined together. Call getCurrentValueModel if you need the active version number to guard a follow-up write.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

slugstringRequired>=1 character

Response

200

slugstring

namestring

categorystring or null

unitobject

descriptionstring or null

longDescriptionstring or null

sourceslist of objects or null

archivedAtstring or null

monetaryConversionobject or null

formulaobject or null

signalslist of objects

Errors

404

Not Found Error

500

Internal Server Error