Shipeasy
Flags experimentsApiOperations

Get a metric

Fetch one metric by its id or name, including the rendered DSL query and the typed IR.

Fetch one metric by its id or name, including the rendered DSL query and the typed IR.

Use case

Inspect a single metric's full definition before reusing it in an experiment or alert rule.

GET
/api/admin/metrics/{id}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque metric id (met_…) or the metric's name.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/metrics/string"
{
  "id": "met_01j7w8a1b2c3d4e5f6g7h8i9j0",
  "name": "revenue",
  "folder": "checkout",
  "eventName": "purchase",
  "query": "sum(purchase, amount)",
  "queryIr": {
    "agg": {
      "kind": "sum"
    },
    "metric": "purchase",
    "valueLabel": "amount",
    "filters": []
  },
  "direction": "higher_better",
  "winsorizePct": 99
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page