Skip to main content
POST
Record a Coverage batch

Authorizations

Authorization
string
header
required

A sandbox or production secret key.

Headers

Idempotency-Key
string
required

A caller-owned key for safely retrying one write.

Required string length: 8 - 255
X-Heyrafiki-Artifact-Reference
string
required

Stable reference for the source artifact retained by the payer.

Required string length: 1 - 190
Pattern: ^[A-Za-z0-9][A-Za-z0-9:._/-]*$

Body

application/json
contract_version
string
required
Allowed value: "2026-08-01"
batch_reference
string
required
Required string length: 1 - 220
Pattern: ^[A-Za-z0-9][A-Za-z0-9:._/-]*$
batch_version
string
required
Required string length: 1 - 120
source_contract_reference
string
required
Required string length: 1 - 220
Pattern: ^[A-Za-z0-9][A-Za-z0-9:._/-]*$
generated_at
string<date-time>
required
records
object[]
required
Required array length: 1 - 500 elements

Response

A replayed Coverage batch result

object
string
required
Allowed value: "coverage_batch_result"
batch_reference
string
required
artifact_sha256
string
required
Pattern: ^[a-f0-9]{64}$
total
integer
required
Required range: 1 <= x <= 500
recorded
integer
required
Required range: 0 <= x <= 500
replayed
integer
required
Required range: 0 <= x <= 500
observations
object[]
required
Required array length: 1 - 500 elements
Last modified on August 6, 2026