API Reference

Poll a public dashboard action run status

GET /api/public/dashboards/{token}/action-runs/{actionRunId}/status

Mirror of GET /api/dashboards/{id}/action-runs/{actionRunId}/status. Scoped to this dashboard's action runs only; never returns logs. Gated by ENVOY_PUBLIC_DASHBOARD_ACTIONS_ENABLED.

Operation IDgetPublicDashboardActionRunStatus

Authentication

No authentication is required.

Path parameters

tokenstringrequired

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"
}

503Public dashboard actions disabled on this server

Public dashboard actions disabled on this server

No response content schema is documented.

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/action-runs/YOUR_ACTION_RUN_ID/status'

const response = await fetch("https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/action-runs/YOUR_ACTION_RUN_ID/status", {
  method: "GET",
});

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