ProjectExportEstimate

Fields

GET /projects/{id}/export-estimate: counts only. A store that could not be read → its counts None and measured[store] = False (absence is not health — never 0).

12 fields

documents: object or null
estimated_bytes: integer or null
history_days: integer or null
include_history · required: boolean
measured · required: object
object_bytes: integer or null
objects: integer or null
over_limit: boolean or null
runs: integer or null
runs_in_progress: integer or null
runs_over_cap: integer or null
test_cases: integer or null

Raw schema (JSON)

{
  "description": "``GET /projects/{id}/export-estimate``: counts only. A store that could not be read → its counts None and\n``measured[store] = False`` (absence is not health — never 0).",
  "properties": {
    "documents": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "integer"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Documents"
    },
    "estimated_bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Estimated Bytes"
    },
    "history_days": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "History Days"
    },
    "include_history": {
      "title": "Include History",
      "type": "boolean"
    },
    "measured": {
      "additionalProperties": {
        "type": "boolean"
      },
      "title": "Measured",
      "type": "object"
    },
    "object_bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Object Bytes"
    },
    "objects": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Objects"
    },
    "over_limit": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Over Limit"
    },
    "runs": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Runs"
    },
    "runs_in_progress": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Runs In Progress"
    },
    "runs_over_cap": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Runs Over Cap"
    },
    "test_cases": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Test Cases"
    }
  },
  "required": [
    "include_history",
    "measured"
  ],
  "title": "ProjectExportEstimate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

GET /api/v1/projects/{project_id}/export-estimate — Estimate Project Export

Used by schemas

No other schema contains this one.

More details

Specification: OpenAPI JSON