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ámetroTipoObligatorioDescripción
project_idintegerSí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_idintegerNoOnly 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_datestringSíFirst day, inclusive, as YYYY-MM-DD.
to_datestringSíLast day, inclusive, as YYYY-MM-DD.
retention_typestringNobirth, the default, follows users from the first time they did born_event. compounded counts recurring returns.Valores: birth, compounded
born_eventstringNoEvent that puts a user in a cohort, from List event names. Required when retention_type is birth.
eventstringNoEvent counted as a return, from List event names. Omit it to count any event.
born_wherestringNoExpression that filters the born events, for example properties["$os"] == "iOS".
wherestringNoExpression that filters the events of the query, for example properties["$browser"] == "Chrome".
unitstringNoUnit of the intervals. The default is day.Valores: day, week, month
intervalintegerNoUnits in each interval. The default is 1, and with day it can be at most 90.
interval_countintegerNoNumber of intervals returned, besides the 0th interval for returns in less than one interval. The default is 1.
unbounded_retentionbooleanNotrue counts a user as retained in an interval when they came back in it or in any later one. The default is false.
onstringNoProperty expression that segments the return event, for example properties["$browser"]. The property names come from List event properties.
limitintegerNoMaximum 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

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.