Skip to main content
GET
/
reports
/
{report_id}
Get Evaluation
curl --request GET \  --url https://api.promptlayer.com/reports/{report_id} \  --header 'X-API-KEY: <x-api-key>'
{  "success": true,  "message": "<string>",  "report": {  "id": 123,  "name": "<string>",  "comment": "<string>",  "is_blueprint": true,  "deleted": true,  "created_at": "2023-11-07T05:31:56Z",  "updated_at": "2023-11-07T05:31:56Z",  "score": {},  "score_configuration": {},  "score_matrix": [  "<any>"  ],  "score_calculation_error": "<string>",  "parent_report_id": 123,  "dataset_id": 123,  "user_id": 123,  "workspace_id": 123,  "prompt_registry_id": 123,  "prompt_version_number": 123  },  "status": "RUNNING",  "stats": {  "status_counts": {  "COMPLETED": 123,  "FAILED": 123,  "QUEUED": 123,  "RUNNING": 123  }  } }
This endpoint allows you to retrieve the info about a report. Please note that if you want to get the score of a report, you should use the GET /reports/{report_id}/score endpoint instead (link).

Headers

X-API-KEY
string
required

API key to authorize the operation.

Path Parameters

report_id
integer
required

ID of the report to retrieve.

Response

Report retrieved successfully

success
boolean
required
message
string
required
report
object
required

The report data with all fields

status
enum<string>
required

Overall status of the report execution

Available options:
RUNNING,
COMPLETED
stats
object
required
⌘I