Poll dashboard action run status

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

Authentication

Option 1

• BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

• CookieAuth (apiKey) Session cookie set after login + TOTP verification

Path parameters

• id — integer, required Resource ID
• 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"
}

Examples

cURL

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'

JavaScript (fetch)

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