Get workflow run summary

Returns a summary of a single run.

RBAC · workflow

Path parameters

runIdstringRequired

Response body

Success response 200 · schema UnversionedV1Success

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Get workflow run summary.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

404

Run not found.

500

Unexpected error.

GET /api/workflow-runs/{runId}/summary

cURL

curl -X GET "https://algapsa.com/api/workflow-runs/{runId}/summary" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/workflow-runs/{runId}/summary", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/workflow-runs/{runId}/summary");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}