Captura varios eventos a la vez en PostHog. Úsalo para la ingesta masiva de eventos y mejorar el rendimiento.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
projectApiKey
string
Sí
Clave API del proyecto de PostHog (token público para la ingesta de eventos)
region
string
No
Región de PostHog: us (predeterminada) o eu
batch
string
Sí
Matriz JSON de eventos a capturar. Cada evento debe tener: event, distinct_id y, de forma opcional, properties y timestamp. Ejemplo: [{"event": "page_view", "distinct_id": "user123", "properties": {"page": "/"}}]
Salida
Parámetro
Tipo
Descripción
status
string
Mensaje de estado que indica si el lote se capturó correctamente
Ejecuta una consulta HogQL en PostHog. HogQL es el lenguaje de consulta similar a SQL de PostHog para analítica. Úsalo para recuperar y analizar datos de forma avanzada.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
personalApiKey
string
Sí
Clave API personal de PostHog (para acceso autenticado a la API)
region
string
No
Región de PostHog: us (predeterminada) o eu
projectId
string
Sí
ID del proyecto de PostHog
query
string
Sí
Consulta HogQL que ejecutar. Ejemplo: {"kind": "HogQLQuery", "query": "SELECT event, count() FROM events WHERE timestamp > now() - INTERVAL 1 DAY GROUP BY event"}
values
string
No
Cadena JSON opcional con valores de parámetros para consultas parametrizadas. Ejemplo: {"user_id": "123"}
Salida
Parámetro
Tipo
Descripción
results
array
Resultados de la consulta como array de filas
columns
array
Nombres de las columnas del conjunto de resultados
types
array
Tipos de datos de las columnas del conjunto de resultados
Crea una nueva encuesta en PostHog. Admite tipos de pregunta: básica (abierta), enlace, valoración y opción múltiple.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
apiKey
string
Sí
Clave de API personal de PostHog
projectId
string
Sí
ID del proyecto de PostHog
region
string
No
Región de la nube de PostHog: us o eu (predeterminado: us)
name
string
No
Nombre de la encuesta (opcional)
description
string
No
Descripción de la encuesta
type
string
No
Tipo de encuesta: popover (en la aplicación) o api (implementación personalizada) (predeterminado: popover)
questions
string
Sí
Cadena JSON del array de preguntas de la encuesta. Cada pregunta debe tener type (open/link/rating/multiple_choice) y el texto de la pregunta. Las preguntas de valoración pueden tener scale (1-10), lowerBoundLabel, upperBoundLabel. Las preguntas de opción múltiple necesitan un array choices. Las preguntas de enlace pueden tener buttonText.
startDate
string
No
Fecha de inicio de la encuesta en formato ISO 8601
endDate
string
No
Fecha de fin de la encuesta en formato ISO 8601
appearance
string
No
Cadena JSON de la configuración de apariencia (colores, posición, etc.)
conditions
string
No
Cadena JSON de las condiciones de visualización (coincidencia de URL, etc.)
targetingFlagFilters
string
No
Cadena JSON de filtros de feature flag para la segmentación
Listar playlists de grabaciones (posthog_list_recording_playlists)
Listar listas de reproducción de grabaciones de sesiones en un proyecto de PostHog. Las listas de reproducción permiten organizar y seleccionar grabaciones de sesiones.
Entrada
Parámetro
Tipo
Requerido
Descripción
apiKey
string
Sí
Clave API personal de PostHog
projectId
string
Sí
ID de proyecto de PostHog
region
string
No
Región de la nube de PostHog: us o eu (predeterminado: us)
limit
number
No
Número de resultados a devolver (predeterminado: 100)
offset
number
No
Número de resultados a omitir para paginación
Salida
Parámetro
Tipo
Descripción
playlists
array
Lista de listas de reproducción de grabaciones de sesiones
Listar definiciones de eventos (posthog_list_event_definitions)
Lista todas las definiciones de eventos de un proyecto de PostHog. Las definiciones de eventos representan eventos rastreados con metadatos como descripciones, etiquetas y estadísticas de uso.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
projectId
string
Sí
ID del proyecto de PostHog
region
string
Sí
Región de la nube de PostHog: us o eu
apiKey
string
Sí
Clave API personal de PostHog
limit
number
No
Número de resultados que se devuelven por página (por defecto: 100)
offset
number
No
Índice inicial a partir del cual se devuelven los resultados
search
string
No
Término de búsqueda para filtrar definiciones de eventos por nombre
Obtener definición de evento (posthog_get_event_definition)
Obtiene los detalles de una definición de evento específica en PostHog. Devuelve información completa sobre el evento, incluidos metadatos, estadísticas de uso y el estado de verificación.
Entrada
Parameter
Type
Required
Description
projectId
string
Sí
ID del proyecto de PostHog
eventDefinitionId
string
Sí
ID de la definición de evento que se va a recuperar
region
string
Sí
Región de la nube de PostHog: us o eu
apiKey
string
Sí
Clave de API personal de PostHog
Salida
Parameter
Type
Description
id
string
Identificador único de la definición de evento
name
string
Nombre del evento
description
string
Descripción del evento
tags
array
Etiquetas asociadas al evento
volume_30_day
number
Número de eventos recibidos en los últimos 30 días
query_usage_30_day
number
Número de veces que se consultó este evento en los últimos 30 días
created_at
string
Marca de tiempo ISO de creación del evento
last_seen_at
string
Marca de tiempo ISO de la última vez que se vio el evento
Actualizar definición de evento (posthog_update_event_definition)
Actualiza una definición de evento en PostHog. Permite modificar la descripción, las etiquetas y el estado de verificación para mantener esquemas de eventos limpios.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
projectId
string
Sí
ID del proyecto de PostHog
eventDefinitionId
string
Sí
ID de la definición de evento que se va a actualizar
region
string
Sí
Región de la nube de PostHog: us o eu
apiKey
string
Sí
Clave de API personal de PostHog
description
string
No
Descripción actualizada del evento
tags
string
No
Lista de etiquetas separadas por comas para asociar al evento
verified
boolean
No
Indica si se debe marcar el evento como verificado
Salida
Parámetro
Tipo
Descripción
id
string
Identificador único de la definición de evento
name
string
Nombre del evento
description
string
Descripción actualizada del evento
tags
array
Etiquetas actualizadas asociadas al evento
volume_30_day
number
Número de eventos recibidos en los últimos 30 días
query_usage_30_day
number
Número de veces que se consultó este evento en los últimos 30 días
created_at
string
Marca de tiempo ISO de creación del evento
last_seen_at
string
Marca de tiempo ISO de la última vez que se vio el evento
Listar definiciones de propiedades (posthog_list_property_definitions)
Lista todas las definiciones de propiedades de un proyecto de PostHog. Las definiciones de propiedades representan propiedades rastreadas con metadatos como descripciones, etiquetas, tipos y estadísticas de uso.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
projectId
string
Sí
ID del proyecto de PostHog
region
string
Sí
Región de la nube de PostHog: us o eu
apiKey
string
Sí
Clave API personal de PostHog
limit
number
No
Número de resultados que se devolverán por página (valor predeterminado: 100)
offset
number
No
Índice inicial desde el que devolver los resultados
search
string
No
Término de búsqueda para filtrar las definiciones de propiedades por nombre
type
string
No
Filtrar por tipo de propiedad: event, person o group
Obtener definición de propiedad (posthog_get_property_definition)
Obtiene los detalles de una definición de propiedad específica en PostHog. Devuelve información completa sobre la propiedad, incluidos metadatos, tipo, estadísticas de uso y estado de verificación.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
projectId
string
Sí
ID del proyecto de PostHog
propertyDefinitionId
string
Sí
ID de la definición de propiedad que se va a recuperar
region
string
Sí
Región de la nube de PostHog: us o eu
apiKey
string
Sí
Clave de API personal de PostHog
Salida
Parámetro
Tipo
Descripción
id
string
Identificador único de la definición de propiedad
name
string
Nombre de la propiedad
description
string
Descripción de la propiedad
tags
array
Etiquetas asociadas a la propiedad
is_numerical
boolean
Si la propiedad es numérica
is_seen_on_filtered_events
boolean
Si la propiedad aparece en eventos filtrados
property_type
string
Tipo de datos de la propiedad
type
string
Tipo de propiedad: event, person o group
volume_30_day
number
Número de veces que se vio la propiedad en los últimos 30 días
query_usage_30_day
number
Número de veces que se consultó esta propiedad en los últimos 30 días
created_at
string
Marca de tiempo ISO de creación de la propiedad
updated_at
string
Marca de tiempo ISO de actualización de la propiedad
updated_by
object
Usuario que actualizó la propiedad por última vez
verified
boolean
Si la propiedad se ha verificado
verified_at
string
Marca de tiempo ISO de verificación de la propiedad
Actualizar definición de propiedad (posthog_update_property_definition)
Actualiza una definición de propiedad en PostHog. Permite modificar la descripción, las etiquetas, el tipo de propiedad y el estado de verificación para mantener esquemas de propiedades limpios.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
projectId
string
Sí
ID del proyecto de PostHog
propertyDefinitionId
string
Sí
ID de la definición de propiedad a actualizar
region
string
Sí
Región de la nube de PostHog: us o eu
apiKey
string
Sí
Clave de API personal de PostHog
description
string
No
Descripción actualizada de la propiedad
tags
string
No
Lista de etiquetas separadas por comas para asociar con la propiedad
verified
boolean
No
Si se debe marcar la propiedad como verificada
property_type
string
No
El tipo de datos de la propiedad (p. ej., String, Numeric, Boolean, DateTime, etc.)
Salida
Parámetro
Tipo
Descripción
id
string
Identificador único de la definición de propiedad
name
string
Nombre de la propiedad
description
string
Descripción actualizada de la propiedad
tags
array
Etiquetas actualizadas asociadas con la propiedad
is_numerical
boolean
Si la propiedad es numérica
is_seen_on_filtered_events
boolean
Si la propiedad se observa en eventos filtrados
property_type
string
El tipo de datos de la propiedad
type
string
Tipo de propiedad: event, person o group
volume_30_day
number
Número de veces que se observó la propiedad en los últimos 30 días
query_usage_30_day
number
Número de veces que se consultó esta propiedad en los últimos 30 días
created_at
string
Marca de tiempo ISO de creación de la propiedad
updated_at
string
Marca de tiempo ISO de actualización de la propiedad
updated_by
object
Usuario que actualizó la propiedad por última vez
verified
boolean
Si la propiedad ha sido verificada
verified_at
string
Marca de tiempo ISO de verificación de la propiedad
Lista todos los proyectos de la organización. Devuelve los detalles de los proyectos, incluidos IDs, nombres, tokens de API y configuración. Útil para obtener los IDs de proyecto que necesitan otros endpoints.
Lista todas las organizaciones a las que el usuario tiene acceso. Devuelve los detalles de la organización, incluidos el nombre, el slug, el nivel de membresía y las funciones de producto disponibles.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
apiKey
string
Sí
Clave API personal de PostHog
region
string
No
Región de la nube: us o eu (predeterminado: us)
Salida
Parámetro
Tipo
Descripción
organizations
array
Lista de organizaciones con su configuración y funciones
Obtiene información detallada de una organización específica por ID. Devuelve de forma completa la configuración, las funciones, el uso y la información de los equipos de la organización.
Entrada
Parámetro
Tipo
Obligatorio
Descripción
organizationId
string
Sí
ID de organización (UUID)
apiKey
string
Sí
Clave de API personal de PostHog
region
string
No
Región de la nube: us o eu (predeterminado: us)
Salida
Parámetro
Tipo
Descripción
organization
object
Información detallada de la organización con configuración y funciones
Integra PostHog en tu flujo de trabajo. Registra eventos, gestiona feature flags, analiza el comportamiento de los usuarios, ejecuta experimentos, crea encuestas y accede a las grabaciones de sesión.