PostHog · Schema

BatchExportBackfill

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
id string
progress object
start_at string The start of the data interval.
end_at string The end of the data interval.
status object The status of this backfill. * `Cancelled` - Cancelled * `Completed` - Completed * `ContinuedAsNew` - Continued As New * `Failed` - Failed * `FailedRetryable` - Failed Retryable * `Terminated` - Termi
created_at string The timestamp at which this BatchExportBackfill was created.
finished_at string The timestamp at which this BatchExportBackfill finished, successfully or not.
last_updated_at string The timestamp at which this BatchExportBackfill was last updated.
total_records_count integer The total number of records to export. Initially estimated, updated with actual count after completion.
adjusted_start_at string The actual start time after adjustment for earliest available data. May differ from start_at if user requested a date before data exists.
team integer The team this belongs to.
batch_export string The BatchExport this backfill belongs to.
View JSON Schema on GitHub

JSON Schema

posthog-batchexportbackfill-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BatchExportBackfill",
  "title": "BatchExportBackfill",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "progress": {
      "type": "object",
      "nullable": true,
      "properties": {
        "total_runs": {
          "type": "integer",
          "nullable": true
        },
        "finished_runs": {
          "type": "integer",
          "nullable": true
        },
        "progress": {
          "type": "number",
          "nullable": true
        }
      },
      "readOnly": true
    },
    "start_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The start of the data interval."
    },
    "end_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The end of the data interval."
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchExportBackfillStatusEnum"
        }
      ],
      "description": "The status of this backfill.\n\n* `Cancelled` - Cancelled\n* `Completed` - Completed\n* `ContinuedAsNew` - Continued As New\n* `Failed` - Failed\n* `FailedRetryable` - Failed Retryable\n* `Terminated` - Terminated\n* `TimedOut` - Timedout\n* `Running` - Running\n* `Starting` - Starting"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The timestamp at which this BatchExportBackfill was created."
    },
    "finished_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The timestamp at which this BatchExportBackfill finished, successfully or not."
    },
    "last_updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The timestamp at which this BatchExportBackfill was last updated."
    },
    "total_records_count": {
      "type": "integer",
      "maximum": 9223372036854775807,
      "minimum": -9223372036854775808,
      "format": "int64",
      "nullable": true,
      "description": "The total number of records to export. Initially estimated, updated with actual count after completion."
    },
    "adjusted_start_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The actual start time after adjustment for earliest available data. May differ from start_at if user requested a date before data exists."
    },
    "team": {
      "type": "integer",
      "description": "The team this belongs to."
    },
    "batch_export": {
      "type": "string",
      "format": "uuid",
      "description": "The BatchExport this backfill belongs to."
    }
  },
  "required": [
    "batch_export",
    "created_at",
    "id",
    "last_updated_at",
    "progress",
    "status",
    "team"
  ]
}