Evaluators

Retrieve Evaluator Revision

Changed on

Retrieve one evaluator revision, either directly or via an environment key.

Provide one of: an evaluator / variant / revision reference (returns that revision, or the latest revision on the variant or evaluator), or an environment reference plus key (returns the revision currently pinned to that key). Supplying both forms returns 400. Pass resolve=true to expand embedded references on the returned payload.

post/evaluators/revisions/retrieve

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/evaluators/revisions/retrieve
  • Auth
    API key in header Authorization

Request body

keystring nullable

Named deployment key inside the environment revision. Required with environment refs.

resolveboolean nullable

When true, resolve embedded references on the returned revision's data.

include_archivedboolean nullable

When false, an archived evaluator, variant, or revision resolves to nothing.

Response

Successful Response

countinteger

1 when a revision is returned, 0 otherwise.

Changes

    • info

      added the new optional request property

    • info

      added to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status