ProjectDataOptions

Fields

Echoed on an export job: what was asked for.

3 fields

history_days: integer or null
include_history: boolean
max_runs: integer or null

Raw schema (JSON)

{
  "description": "Echoed on an export job: what was asked for.",
  "properties": {
    "history_days": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "History Days"
    },
    "include_history": {
      "default": false,
      "title": "Include History",
      "type": "boolean"
    },
    "max_runs": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Runs"
    }
  },
  "title": "ProjectDataOptions",
  "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

ProjectDataJobRead

More details

Specification: OpenAPI JSON