hotjar · Schema

UserLookupRequest

A request to look up or delete user data across sites in an organization. At least one of data_subject_email or data_subject_site_id_to_user_id_map must be provided.

Properties

Name	Type	Description
data_subject_email	string	The email address of the data subject to look up.
data_subject_site_id_to_user_id_map	object	A map of site IDs to user IDs on your site, used when user attributes have been sent via the Identify API.
delete_all_hits	boolean	Whether to immediately delete all found data for the user. Set to true to submit a deletion request.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserLookupRequest",
  "title": "UserLookupRequest",
  "type": "object",
  "description": "A request to look up or delete user data across sites in an organization. At least one of data_subject_email or data_subject_site_id_to_user_id_map must be provided.",
  "properties": {
    "data_subject_email": {
      "type": "string",
      "format": "email",
      "description": "The email address of the data subject to look up."
    },
    "data_subject_site_id_to_user_id_map": {
      "type": "object",
      "description": "A map of site IDs to user IDs on your site, used when user attributes have been sent via the Identify API.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "delete_all_hits": {
      "type": "boolean",
      "description": "Whether to immediately delete all found data for the user. Set to true to submit a deletion request.",
      "default": false
    }
  }
}