ProjectDataHistoryReport

Fields

Inside ProjectDataImportReport.history.

13 fields

documents

object

newest_run_at

string (date-time) or null

object_bytes

integer

objects

integer

oldest_run_at

string (date-time) or null

recent_runs

integer

retention_days

integer or null

retention_paused_until

string (date-time) or null

runs · required

integer

runs_past_retention

integer

search_reindex · required

string

skipped

array of ProjectDataSkip

test_cases · required

integer

Raw schema (JSON)

{
  "description": "Inside ``ProjectDataImportReport.history``.",
  "properties": {
    "documents": {
      "additionalProperties": {
        "type": "integer"
      },
      "default": {},
      "title": "Documents",
      "type": "object"
    },
    "newest_run_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Newest Run At"
    },
    "object_bytes": {
      "default": 0,
      "title": "Object Bytes",
      "type": "integer"
    },
    "objects": {
      "default": 0,
      "title": "Objects",
      "type": "integer"
    },
    "oldest_run_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Run At"
    },
    "recent_runs": {
      "default": 0,
      "title": "Recent Runs",
      "type": "integer"
    },
    "retention_days": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Retention Days"
    },
    "retention_paused_until": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Retention Paused Until"
    },
    "runs": {
      "title": "Runs",
      "type": "integer"
    },
    "runs_past_retention": {
      "default": 0,
      "title": "Runs Past Retention",
      "type": "integer"
    },
    "search_reindex": {
      "title": "Search Reindex",
      "type": "string"
    },
    "skipped": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/ProjectDataSkip"
      },
      "title": "Skipped",
      "type": "array"
    },
    "test_cases": {
      "title": "Test Cases",
      "type": "integer"
    }
  },
  "required": [
    "runs",
    "test_cases",
    "search_reindex"
  ],
  "title": "ProjectDataHistoryReport",
  "type": "object"
}

Used by endpoints

7 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/project-data-jobs/{data_job_id} — Get Project Data Job
• GET /api/v1/project-imports — List My Project Imports
• POST /api/v1/project-imports/uploads — Start Import Upload
• POST /api/v1/project-imports/uploads/{data_job_id}/complete — Complete Import Upload
• GET /api/v1/projects/{project_id}/data-jobs — List Project Exports
• POST /api/v1/projects/{project_id}/export — Start Project Export
• POST /api/v1/projects/import — Start Project Import

Used by schemas

• ProjectDataImportReport

More details

• Specification: OpenAPI JSON