Authentication
All requests require a Factory API key in theAuthorization header:
Base URL
Endpoints
List Maturity Reports
Retrieves maturity level reports for your organization.Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
repoId | string | No | Filter reports by repository ID |
limit | integer | No | Maximum number of reports to return (must be positive) |
startAfter | string | No | Report ID for pagination cursor |
Response
Example Request
Report Schema
Report Object
| Field | Type | Description |
|---|---|---|
reportId | string | Unique identifier for the report (UUID) |
createdAt | number | Unix timestamp in milliseconds when the report was created |
repoUrl | string | Repository URL that was evaluated |
apps | object | Map of application paths to description objects |
report | object | Map of criterion IDs to evaluation results |
commitHash | string? | Git commit hash at time of evaluation |
branch | string? | Git branch name at time of evaluation |
hasLocalChanges | boolean? | Whether uncommitted changes existed |
hasNonRemoteCommits | boolean? | Whether unpushed commits existed |
modelUsed | object? | Model configuration used for evaluation |
droidVersion | string? | CLI version that generated the report |
App Description Object
| Field | Type | Description |
|---|---|---|
description | string | Brief description of what the application does |
Criterion Evaluation Object
| Field | Type | Description |
|---|---|---|
numerator | number | Number of sub-applications passing the criterion (0 to denominator) |
denominator | number | Number of sub-applications on which the criterion was evaluated (minimum 1) |
rationale | string | Explanation of the evaluation result |
Model Used Object
| Field | Type | Description |
|---|---|---|
id | string | Model identifier |
reasoningEffort | string | Reasoning effort level (low, medium, high, off) |
Pagination
For large result sets, use cursor-based pagination:- Make initial request with desired
limit - Get the
reportIdof the last item in the response - Pass that ID as
startAfterin the next request
Use Cases
CI/CD Integration
Track maturity scores over time by fetching reports after each evaluation:Custom Dashboards
Build internal dashboards by fetching all reports and calculating aggregate metrics:Automated Alerting
Set up alerts when maturity scores drop below thresholds:Error Responses
| Status | Description |
|---|---|
400 | Invalid request parameters |
401 | Missing or invalid API key |
500 | Internal server error |
