Skip to main content
Retrieve a single project by its ID. The response includes the project’s configuration and aggregate statistics — the total number of analyses and the average score across completed analyses — giving you a quick summary of project-wide performance.

Endpoint

GET https://api.screenscoreai.com/v1/projects/{id}

Path parameters

id
string
required
The project ID to retrieve. Project IDs are prefixed proj_.

Example request

curl --request GET \
  --url https://api.screenscoreai.com/v1/projects/proj_01hx4k2m9fvbzq3rcw7ndj6e5t \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

id
string
required
Unique identifier for the project, prefixed proj_.
name
string
required
The display name of the project.
description
string
The project description, or null if none was provided.
default_criteria
object
The scoring weights configured for this project. null if none were specified (platform defaults apply).
analysis_count
integer
required
Total number of analyses in this project, across all statuses.
avg_score
number
Average score across all completed analyses in this project, rounded to one decimal place. null if no analyses have completed yet.
created_at
string
required
ISO 8601 timestamp of when the project was created.
updated_at
string
required
ISO 8601 timestamp of the most recent update to the project.

Example response

{
  "id": "proj_01hx4k2m9fvbzq3rcw7ndj6e5t",
  "name": "Q2 Landing Page Redesign",
  "description": "A/B test variants for the product landing page refresh launching in Q2.",
  "default_criteria": {
    "visual_clarity": 20,
    "visual_hierarchy": 20,
    "color_contrast": 20,
    "cta_effectiveness": 30,
    "brand_consistency": 10
  },
  "analysis_count": 12,
  "avg_score": 73.4,
  "created_at": "2026-04-16T09:00:00Z",
  "updated_at": "2026-04-16T11:45:30Z"
}