API Reference

Results API

Result queries and export.

Overview

Access per-case outcomes from completed validation runs.

Use organization-scoped API keys with Bearer authentication. All responses are JSON unless downloading binary report artifacts. List endpoints support cursor pagination; mutating operations accept Idempotency-Key headers.

Who should read this

  • Engineers building automation against Zof for CMDB sync, CI gates, reporting, and integration health checks.

Prerequisites

  • API key with read access minimum; write operations require appropriate role
  • Familiarity with REST and JSON

Results workflow

Results workflow

Typical integration pattern

Best practices

  • Test mutations in staging before production automation
  • Cache resource IDs from list responses; avoid hard-coding in multiple services
  • Subscribe to webhooks for run completion instead of polling where possible

API operations

GET
/results
Query results with run_id, status, and date filters.
GET
/results/{id}
Detailed outcome including duration, logs reference, and failure summary.
GET
/results/{id}/artifacts
List screenshots, traces, and exports for a result.
POST
/results/export
Bulk export results as CSV or JSON for analytics pipelines.

Was this page helpful?