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 ID: getPublicDashboardActionRunStatus

Authentication

No authentication is required.

Path parameters

• token — string, required
• actionRunId — integer, required

Success responses

200

Action run status

Content type: application/json

• Reference: DashboardActionRunStatus
  • Type: object
  • Properties:
    • status (string, required)
    • item_count (integer | null)
      • Nullable: yes
    • duration_ms (integer | null)
      • Nullable: yes
    • error_message (string | null)
      • Nullable: yes

Error responses

404

Resource not found

Content type: application/json

• Reference: Error
  • Type: object
  • Properties:
    • error (string)
      • Example: NOT_FOUND
    • message (string)
      • Example: Resource not found

Example:

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

503

Public dashboard actions disabled on this server

Examples

cURL

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

JavaScript (fetch)

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);