Retrieve usage metrics for a workflow

GET 
https://embedded.runalloy.com/2024-03//workflows/:workflowId/analytics

This endpoint returns the totalAppActions (the number of times each block inside the workflow has been executed over the course of the workflow's lifetime), the totalWorkflowRuns (which represents the number of times the workflow has been invoked) and the totalErrors (the number of times the workflow has had an error).

Request

Path Parameters

workflowId stringrequired

The Id of the workflow you want to find errors for

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

totalAppActions integer

Default value: 0

totalWorkflowRuns integer

Default value: 0

totalErrors integer

Default value: 0

Example (from schema)

{
  "totalAppActions": 14,
  "totalWorkflowRuns": 14,
  "totalErrors": 0
}

Result

{
    "totalAppActions": 14,
    "totalWorkflowRuns": 14,
    "totalErrors": 0
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://embedded.runalloy.com/2024-03/workflows/:workflowId/analytics' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://embedded.runalloy.com/2024-03

Parameters

workflowId — pathrequired

Authorization — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!