Obtener informe de retención en Mixpanel, con una API
Devuelve, para cada fecha de cohorte, cuántos usuarios entraron en la cohorte (first) y cuántos volvieron en cada intervalo posterior (counts). Cuenta para el límite de la Query API de 60 consultas por hora.
- Identificador
- mixpanel_get_retention_report
La llamada
POST https://connect.reportei.com/api/tools/mixpanel_get_retention_report/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"project_id": 1,
"from_date": "<from_date>",
"to_date": "<to_date>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| project_id | integer | Sí | Id of the project, sent as a number: a key of results.projects in List projects, or the number after /project/ in the URL of Mixpanel. |
| workspace_id | integer | No | Only for projects that use data views: the id of the global data view, a key of results.workspaces in List projects, sent as a number. |
| from_date | string | Sí | First day, inclusive, as YYYY-MM-DD. |
| to_date | string | Sí | Last day, inclusive, as YYYY-MM-DD. |
| retention_type | string | No | birth, the default, follows users from the first time they did born_event. compounded counts recurring returns.Valores: birth, compounded |
| born_event | string | No | Event that puts a user in a cohort, from List event names. Required when retention_type is birth. |
| event | string | No | Event counted as a return, from List event names. Omit it to count any event. |
| born_where | string | No | Expression that filters the born events, for example properties["$os"] == "iOS". |
| where | string | No | Expression that filters the events of the query, for example properties["$browser"] == "Chrome". |
| unit | string | No | Unit of the intervals. The default is day.Valores: day, week, month |
| interval | integer | No | Units in each interval. The default is 1, and with day it can be at most 90. |
| interval_count | integer | No | Number of intervals returned, besides the 0th interval for returns in less than one interval. The default is 1. |
| unbounded_retention | boolean | No | true counts a user as retained in an interval when they came back in it or in any later one. The default is false. |
| on | string | No | Property expression that segments the return event, for example properties["$browser"]. The property names come from List event properties. |
| limit | integer | No | Maximum number of segments when on is sent. |
Conexiones posibles
Tu cliente conecta su cuenta de Mixpanel una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Usuario y contraseña
Tu cliente ingresa las credenciales de la app en una pantalla de Connect, o tu sistema las envía con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/mixpanel_get_retention_report. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Mixpanel
- Listar proyectosGETDevuelve, en results, la propia cuenta de servicio y las organizaciones, proyectos y workspaces a los que tiene acceso, cada uno indexado por id. Las claves de results.projects son el project_id que piden las otras herramientas, y results.workspaces trae el workspace_id de los proyectos que usan data views.
- Obtener informe guardadoGETDevuelve los datos de un informe guardado de Insights o Funnels, calculado con el rango de fechas y los filtros guardados en el informe. Cuenta para el límite de la Query API de 60 consultas por hora.
- Listar nombres de eventosGETLista los nombres de los eventos más comunes del proyecto en los últimos 31 días, para usarlos como argumentos event de las otras herramientas. Cuenta para el límite de la Query API de 60 consultas por hora.
- Listar propiedades de eventoGETLista los nombres de propiedad más comunes de un evento, para construir las expresiones on y where de Obtener informe de retención. Cuenta para el límite de la Query API de 60 consultas por hora.
- Obtener conteos de eventosGETDevuelve, periodo a periodo, el conteo total, único o promedio de uno o más eventos entre dos fechas. Cuenta para el límite de la Query API de 60 consultas por hora.
- Listar cohortesPOSTLista las cohortes guardadas del proyecto con id, nombre, número de usuarios, descripción, fecha de creación y visibilidad. Cuenta para el límite de la Query API de 60 consultas por hora.
- Buscar perfilesPOSTDevuelve los perfiles de usuario que coinciden con una expresión where, una cohorte o una lista de distinct_ids, con sus propiedades. Una página trae hasta page_size perfiles: para la siguiente, repite la llamada con los mismos filtros, el session_id de la respuesta y page más uno. Cuenta para el límite de la Query API de 60 consultas por hora.
- Listar anotacionesGETLista las anotaciones del proyecto, las notas fijadas en una fecha en los gráficos, con id, fecha, descripción, autor y tags.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
