API Reference

Get run summary for a task

View Markdown

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

Aggregated run statistics from the runs table.

Operation IDgetMetricsSummary

Authentication

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

Path parameters

taskIdintegerrequired

Success response body

200Task run summary

Task run summary

Content typeapplication/json

responseobject

8 properties

availableboolean

taskstring

total_runsinteger

success_countinteger

error_countinteger

total_itemsinteger

durationobject

3 properties

avg_msnumber | null

Nullable: yes

min_msnumber | null

Nullable: yes

max_msnumber | null

Nullable: yes

last_run_atstring | null · date-time

Nullable: yes

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/summary/YOUR_TASK_ID' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/metrics/data/summary/YOUR_TASK_ID", {
  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);