Skip to main content
GET
/
api
/
dataframer
/
runs
/
{run_id}
/
evaluations
Python
import os
from dataframer import Dataframer

client = Dataframer(
    api_key=os.environ.get("DATAFRAMER_API_KEY"),  # This is the default and can be omitted
)
evaluations = client.dataframer.runs.evaluations.list(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(evaluations)
[
  {
    "id": "f4e64db3-3cac-4706-9fd0-c6695ae4694a",
    "run_id": "a98715da-921d-4326-bbf8-208f8bcc2956",
    "status": "SUCCEEDED",
    "conformance_score": 85.5,
    "started_at": "2025-01-15T10:30:00Z",
    "completed_at": "2025-01-15T10:31:00Z",
    "created_by_email": "[email protected]",
    "created_at": "2025-01-15T10:30:00Z"
  },
  {
    "id": "024319ff-7534-4f26-ba80-e540af493863",
    "run_id": "a98715da-921d-4326-bbf8-208f8bcc2956",
    "status": "PENDING",
    "conformance_score": null,
    "started_at": null,
    "completed_at": null,
    "created_by_email": "[email protected]",
    "created_at": "2025-01-15T11:00:00Z"
  }
]
Returns a summary list of evaluations. Use Get evaluation to retrieve full details including distribution analysis and sample classifications.

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

​
run_id
string<uuid>
required

Unique identifier of the run to evaluate

Response

List of evaluations for the run

​
id
string<uuid>
read-only

Unique identifier for the evaluation

​
run_id
string<uuid>
read-only

ID of the run being evaluated

​
status
enum<string>

Current status of the evaluation

Available options:
PENDING,
PROCESSING,
SUCCEEDED,
FAILED
​
conformance_score
number | null

Overall conformance score (0-100). Null until evaluation completes.

​
started_at
string<date-time> | null
read-only

When evaluation processing started

​
completed_at
string<date-time> | null
read-only

When evaluation completed

​
created_by_email
string
read-only

Email of the user who created the evaluation

​
created_at
string<date-time>
read-only

When the evaluation was created

​
status_display
string
read-only

Human-readable status display