API Reference

Poll dashboard action run status

View Markdown

GET /api/dashboards/{id}/action-runs/{actionRunId}/status

Returns a minimal status payload for an action run scoped to this dashboard. Never returns logs.

Operation IDgetDashboardActionRunStatus

Authentication

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

Path parameters

idintegerrequired

Resource ID

actionRunIdintegerrequired

Success response body

200Action run status

Action run status

Content typeapplication/json

responseobject

4 properties

statusstringrequired

item_countinteger | null

Nullable: yes

duration_msinteger | null

Nullable: yes

error_messagestring | null

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/dashboards/YOUR_ID/action-runs/YOUR_ACTION_RUN_ID/status' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/dashboards/YOUR_ID/action-runs/YOUR_ACTION_RUN_ID/status", {
  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);