Shipeasy
APIOperations

Read a trail's release facts

The traffic is read from proxy when given (metric:<key>, event:<name> or flag:<key>), else the trail's goal metric, else a flag already on the trail. With…

The traffic is read from proxy when given (metric:<key>, event:<name> or flag:<key>), else the trail's goal metric, else a flag already on the trail. With nothing to read the tier is none — pass an event on the surface the trail changes.

The plan run reads these before it asks how to ship, and submit-plan checks the plan against them. Read-only. Safe for the restricted ops key.

GET
/api/admin/trails/{handle}/release-facts

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

handle*string

The trail's handle (T-12) or its id.

Match^(?:T-[0-9]+|[0-9a-fA-F-]{32,36})$
Length1 <= length <= 64

Query Parameters

proxy?string

What to read the traffic from — metric:<key>, event:<name> or flag:<key>.

Match^(metric|event|flag):.+$
Lengthlength <= 220

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

curl -X GET "https://shipeasy.ai/api/admin/trails/string/release-facts"
{
  "proxy": {
    "kind": "event",
    "key": "onboarding_viewed"
  },
  "tier": "low",
  "unitsPerDay": 120,
  "rollout": {
    "internal": {
      "holdMinutes": 1440
    },
    "steps": [
      50,
      100
    ],
    "holdMinutes": 1440,
    "minExposure": 50
  },
  "notes": [
    "Traffic: ~120 units a day (low, from event `onboarding_viewed` over 28 days)"
  ]
}
{
  "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"
}
Was this page helpful?