evaluations

get/api/projects/{project_id}/evaluations/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/evaluations/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this evaluation.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

idstring uuid required
namestring required

Name of the evaluation.

descriptionstring

Optional description of what this evaluation checks.

directory_idstring uuid nullable

Directory containing the evaluation. Pass null to move the evaluation to the top level.

enabledboolean

Whether the evaluation runs automatically on new $ai_generation events.

status'active' | 'paused' | 'error' required
  • active - Active
  • paused - Paused
  • error - Error
status_reason_detailstring nullable required

Additional detail for the current system-disabled status. This is only populated when the detail is safe to show in the evaluation UI.

evaluation_type'llm_judge' | 'hog' | 'sentiment' required
  • llm_judge - LLM as a judge
  • hog - Hog
  • sentiment - Sentiment analysis
output_type'boolean' | 'numeric' | 'categorical' | 'sentiment' required
  • boolean - Boolean (Pass/Fail)
  • numeric - Numeric
  • categorical - Categorical
  • sentiment - Sentiment
target'generation' | 'trace' | 'session'
  • generation - Generation
  • trace - Trace
  • session - Session
created_atstring date-time required
updated_atstring date-time required
deletedboolean

Set to true to soft-delete the evaluation.

user_access_levelstring nullable required

The effective access level the user has for this object

Changes

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