GRgraypass
canonical

Close a shadow evaluation

Fix the study cutoff and return the resulting criteria report.

post/api/v1/evaluations/{evaluation_id}/close

Request

  • Base URL
    https://app.graypass.org (the document declares no server; this is the origin it was published from)
  • URL
    https://app.graypass.org/api/v1/evaluations/{evaluation_id}/close
  • Auth
    HTTP bearer

Path parameters

evaluation_idstring required

Evaluation identifier returned when the study was created.

Response

Closed evaluation report with fixed cutoff and final registered-criterion result.

action_keysstring[] required

Registered action keys included in the evaluation; the service deduplicates this selection.

checksobject required

Per-criterion pass/fail results against the recorded thresholds.

created_atstring required

Creation time as an ISO 8601 timestamp.

ends_atstring nullable

Timezone-aware ISO 8601 study end, later than starts_at. Creation defaults to 30 days after the start; closing can shorten this cutoff.

idstring required

Identifier of this record. Treat it as opaque and retain it for subsequent operations.

namestring required

Customer-visible display name for the action or evaluation.

result'in_progress' | 'passed' | 'failed' required

passed when all recorded criteria are met; otherwise in_progress for an open study or failed for a closed study. An open study can pass before closure; close it to fix the cutoff.

starts_atstring required

Timezone-aware ISO 8601 study start. If omitted during creation, the service uses the current time.

status'open' | 'closed' required

Lifecycle state of this record; use the operation-specific values listed in the schema.

Changes

No recorded changes to this operation across all 1 revision of this API.