API Reference
Projects
API endpoints for creating and managing visual testing projects.
project.list
List all projects for the authenticated user.
| Type | Query |
| Auth | Protected |
| Input | None |
Response: Project[]
project.byId
Get a project by ID with its comparisons.
| Type | Query |
| Auth | Protected |
Input:
{
id: string;
} // UUIDResponse:
{
id: string;
name: string;
description: string | null;
color: string | null;
status: string;
createdAt: string;
updatedAt: string;
comparisons: Comparison[];
}project.create
Create a new project.
| Type | Mutation |
| Auth | Protected |
Input:
{
name: string;
description?: string;
color?: string;
status?: string;
}project.update
Update project details.
| Type | Mutation |
| Auth | Protected |
Input:
{
id: string;
name?: string;
description?: string;
color?: string;
status?: string;
}project.delete
Delete a project and all associated data.
| Type | Mutation |
| Auth | Protected |
Input:
{
id: string;
}project.stats
Get aggregate statistics across all projects.
| Type | Query |
| Auth | Protected |
| Input | None |
Response:
{
projectCount: number;
comparisonCount: number;
fixesApplied: number;
totalDiffs: number;
}project.healthScores
Get health scores for all projects.
| Type | Query |
| Auth | Protected |
| Input | None |
Response:
Array<{
projectId: string;
projectName: string;
healthScore: number; // 0-100
fixRate: number; // Percentage of diffs fixed
resolvedRate: number; // Percentage resolved
baselineCoverage: number; // Baseline coverage percentage
perfScore: number; // Performance score
comparisons: number;
diffs: number;
}>;