API Reference

Get timeseries data for a task

View Markdown

GET /api/metrics/data/timeseries/{taskId}

Daily data points from the metrics database.

Operation IDgetMetricsTimeseries

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

taskIdintegerrequired

Query parameters

daysinteger

Number of days to look back

Default: 30
Maximum: 90

Success response body

200Timeseries data

Timeseries data

Content typeapplication/json

responseobject

3 properties

availableboolean

taskstring

pointsarray<object>

Array items

itemobject

5 properties

daystring · date

successinteger

errorinteger

avg_duration_msnumber

total_itemsinteger

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/metrics/data/timeseries/YOUR_TASK_ID?days=30' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/metrics/data/timeseries/YOUR_TASK_ID?days=30", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);