Skip to main content
GET
/
api
/
dataframer
/
evaluations
/
{evaluation_id}
JavaScript
import Dataframer from 'dataframer';

const client = new Dataframer({
  apiKey: 'My API Key',
});

const evaluation = await client.dataframer.evaluations.retrieve('evaluation_id');

console.log(evaluation.run_id);
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "PENDING",
  "status_display": "<string>",
  "conformance_score": 123,
  "conformance_explanation": "<string>",
  "conformant_areas": "<string>",
  "non_conformant_areas": "<string>",
  "distribution_analysis": {},
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "trace": {},
  "created_by": 123,
  "created_by_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sample_classifications": [
    {
      "evaluation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sample_identifier": "<string>",
      "classifications": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sub_file_classifications": {},
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "duration_seconds": 123
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

​
evaluation_id
string
required

Response

200 - application/json
​
run_id
string<uuid>
required
​
id
string<uuid>
​
company_id
string<uuid>
​
status
enum<string>
Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED
​
status_display
string
Minimum string length: 1
​
conformance_score
number | null

Score between 0-100 indicating conformance to requirements

​
conformance_explanation
string | null

Explanation of the conformance score

​
conformant_areas
string
​
non_conformant_areas
string
​
distribution_analysis
Distribution analysis · object

JSON containing observed vs expected distributions for each axis

​
started_at
string<date-time> | null
​
completed_at
string<date-time> | null
​
error_message
string | null
​
trace
Trace · object

Trace information for debugging

​
created_by
integer | null
​
created_by_name
string
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
sample_classifications
object[]
​
duration_seconds
number