Shipeasy
Flags experimentsApiOperations

Get an error's occurrence series

Returns a bucketed occurrence timeseries for one tracked error (by its fingerprint), read from the shipeasy_errors Analytics Engine dataset (near-real-time;…

Returns a bucketed occurrence timeseries for one tracked error (by its fingerprint), read from the shipeasy_errors Analytics Engine dataset (near-real-time; ingest lag is seconds). The window bounds are epoch seconds; to must be strictly greater than from. The response echoes the SQL that produced the rows.

Use case

Render the trend sparkline / occurrence chart on the error detail panel, or pull the raw bucketed counts to alert when an issue's rate spikes.

POST
/api/admin/errors/{id}/series

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 error id (err_…).

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).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://shipeasy.ai/api/admin/errors/string/series" \  -H "Content-Type: application/json" \  -d '{    "from": 1751000400,    "to": 1751086800,    "bucket": 3600  }'
{
  "sql": "SELECT intDiv(toUInt32(double2), 3600) * 3600 AS t,\n  sum(double1 * _sample_interval) AS v\nFROM shipeasy_errors\nWHERE index1 = 'e976b15e-2f0d-4c6e-9b1a-3a7c1f2d8e90'\n  AND blob1 = '9c1f4f1f2c0c4a5fa1c2b6d3e7c8e3a1'\n  AND double2 >= 1751000400 AND double2 < 1751086800\nGROUP BY t\nORDER BY t",
  "rows": [
    {
      "t": 1751000400,
      "v": 12
    },
    {
      "t": 1751004000,
      "v": 31
    },
    {
      "t": 1751007600,
      "v": 27
    }
  ]
}
{
  "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