Estimate Project Export — GET /api/v1/projects/{project_id}/export-estimate
Estimate Project Export
What an export with these options would hold — counts only (the export’s rule: QA lead or ADMIN with access). Writes NOTHING (no job, no object, no cache). An unreachable Mongo / object store answers measured[store] = false with NULL counts (200, never 0). history_days absent = all history.
Endpoint: GET /api/v1/projects/{project_id}/export-estimate
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- A minimum role applies. The source code names it.
- You must be a member of the project. Admins always have access.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
project_id | path | yes | string (uuid) | ||
include_history | query | no | boolean | true | |
history_days | query | no | integer or null | ||
max_runs | query | no | integer | 2000 | |
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | ProjectExportEstimate (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
404, with the message “Project not found”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Project data
- Operation ID:
estimate_project_export_api_v1_projects__project_id__export_estimate_get - Source code:
backend/app/routers/project_data.py, line 233 - Specification: OpenAPI JSON