PostHog · Schema

PersonBulkDeleteResponse

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
persons_found integer Number of persons matched by the provided IDs or distinct IDs.
persons_deleted integer Number of person records deleted from the database. 0 if keep_person was true.
events_queued_for_deletion boolean Whether event deletion was requested for the matched persons. If a deletion was already queued for a person, it will not be duplicated.
recordings_queued_for_deletion boolean Whether recording deletion was requested for the matched persons. If a deletion was already queued for a person, it will not be duplicated.
deletion_errors array Persons that could not be deleted. Each entry contains 'person_uuid'. Contact support if this persists.
View JSON Schema on GitHub

JSON Schema

posthog-personbulkdeleteresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PersonBulkDeleteResponse",
  "title": "PersonBulkDeleteResponse",
  "type": "object",
  "properties": {
    "persons_found": {
      "type": "integer",
      "description": "Number of persons matched by the provided IDs or distinct IDs."
    },
    "persons_deleted": {
      "type": "integer",
      "description": "Number of person records deleted from the database. 0 if keep_person was true."
    },
    "events_queued_for_deletion": {
      "type": "boolean",
      "description": "Whether event deletion was requested for the matched persons. If a deletion was already queued for a person, it will not be duplicated."
    },
    "recordings_queued_for_deletion": {
      "type": "boolean",
      "description": "Whether recording deletion was requested for the matched persons. If a deletion was already queued for a person, it will not be duplicated."
    },
    "deletion_errors": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "description": "Persons that could not be deleted. Each entry contains 'person_uuid'. Contact support if this persists."
    }
  },
  "required": [
    "events_queued_for_deletion",
    "persons_deleted",
    "persons_found",
    "recordings_queued_for_deletion"
  ]
}