AIXBT Docs
API v3Reference

Get a Project measurement series

GET
/v3/projects/{idOrSlug}/series/{measure}

One series contract for the public measures. trend is the hourly canonical score history; rank is the committed rank-transition series exactly as recorded: change points, not resampled intervals (value is null while unranked). meta.basis states which. Points are objects, never positional arrays.

Authorization

ApiKeyAuth
x-api-key<token>

API key. The Authorization header is accepted as an equivalent carrier. Responses echo the credential class in X-API-Key-Type.

In: header

Path Parameters

idOrSlug*string

Canonical Project id or public slug (aliases resolve).

measure*string
Value in"trend" | "rank"

Query Parameters

from?string
Formatdate-time
to?string
Formatdate-time
include?string

clusters adds per-point cluster attribution to trend series.

Value in"clusters"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v3/projects/string/series/trend"

{
  "data": {
    "project": {
      "id": "665f0a2b1c9d440000a1b2c3",
      "slug": "examplechain",
      "name": "ExampleChain"
    },
    "points": [
      {
        "at": "2026-08-05T03:00:00Z",
        "value": 84.1
      },
      {
        "at": "2026-08-05T04:00:00Z",
        "value": 87.4
      }
    ]
  },
  "meta": {
    "measure": "trend",
    "basis": "hourly",
    "window": {
      "from": "2026-08-04T05:00:00Z",
      "to": "2026-08-05T05:00:00Z"
    }
  }
}

{
  "code": "invalid_request",
  "message": "minTrend must be numeric",
  "details": {
    "fields": [
      "minTrend"
    ]
  }
}

{
  "code": "credential_required",
  "message": "Provide an API key via the x-api-key header."
}

{
  "code": "entitlement_required",
  "message": "This resource requires the topic-reports entitlement.",
  "details": {
    "entitlement": "topic-reports"
  }
}

{
  "code": "not_found",
  "message": "No Project matches that locator.",
  "details": {
    "subject": {
      "type": "project",
      "locator": "examplechain"
    }
  }
}

{
  "code": "rate_limited",
  "message": "Minute limit reached.",
  "details": {
    "limit": 30,
    "window": "minute"
  }
}
{
  "code": "internal_error",
  "message": "Unexpected error."
}
{
  "code": "service_unavailable",
  "message": "Measurement history is temporarily unavailable."
}