Obtenir le rapport de rétention avec l'API Mixpanel
Renvoie, pour chaque date de cohorte, combien d'utilisateurs sont entrés dans la cohorte (first) et combien sont revenus à chaque intervalle suivant (counts). Compte dans la limite de la Query API de 60 requêtes par heure.
- Identifiant
- mixpanel_get_retention_report
L'appel
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>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| project_id | integer | Oui | 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 | Non | 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 | Oui | First day, inclusive, as YYYY-MM-DD. |
| to_date | string | Oui | Last day, inclusive, as YYYY-MM-DD. |
| retention_type | string | Non | birth, the default, follows users from the first time they did born_event. compounded counts recurring returns.Valeurs : birth, compounded |
| born_event | string | Non | Event that puts a user in a cohort, from List event names. Required when retention_type is birth. |
| event | string | Non | Event counted as a return, from List event names. Omit it to count any event. |
| born_where | string | Non | Expression that filters the born events, for example properties["$os"] == "iOS". |
| where | string | Non | Expression that filters the events of the query, for example properties["$browser"] == "Chrome". |
| unit | string | Non | Unit of the intervals. The default is day.Valeurs : day, week, month |
| interval | integer | Non | Units in each interval. The default is 1, and with day it can be at most 90. |
| interval_count | integer | Non | Number of intervals returned, besides the 0th interval for returns in less than one interval. The default is 1. |
| unbounded_retention | boolean | Non | 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 | Non | Property expression that segments the return event, for example properties["$browser"]. The property names come from List event properties. |
| limit | integer | Non | Maximum number of segments when on is sent. |
Connexions possibles
Votre client connecte son compte Mixpanel une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Identifiant et mot de passe
Votre client saisit les identifiants de l'app sur un écran de Connect, ou votre système les envoie avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/mixpanel_get_retention_report. Il devient la définition de tool de votre agent sans conversion.
Autres tools Mixpanel
- Lister les projetsGETRenvoie, dans results, le compte de service lui-même ainsi que les organisations, projets et workspaces auxquels il a accès, chacun indexé par id. Les clés de results.projects sont le project_id que demandent les autres outils, et results.workspaces contient le workspace_id des projets qui utilisent des data views.
- Obtenir un rapport enregistréGETRenvoie les données d'un rapport Insights ou Funnels enregistré, calculées avec la plage de dates et les filtres enregistrés dans le rapport. Compte dans la limite de la Query API de 60 requêtes par heure.
- Lister les noms d'événementsGETListe les noms des événements les plus courants du projet sur les 31 derniers jours, à utiliser comme arguments event des autres outils. Compte dans la limite de la Query API de 60 requêtes par heure.
- Lister les propriétés d'événementGETListe les noms de propriété les plus courants d'un événement, pour construire les expressions on et where d'Obtenir un rapport de rétention. Compte dans la limite de la Query API de 60 requêtes par heure.
- Obtenir les décomptes d'événementsGETRenvoie, période par période, le décompte total, unique ou moyen d'un ou plusieurs événements entre deux dates. Compte dans la limite de la Query API de 60 requêtes par heure.
- Lister les cohortesPOSTListe les cohortes enregistrées du projet avec id, nom, nombre d'utilisateurs, description, date de création et visibilité. Compte dans la limite de la Query API de 60 requêtes par heure.
- Rechercher des profilsPOSTRenvoie les profils utilisateurs qui correspondent à une expression where, une cohorte ou une liste de distinct_ids, avec leurs propriétés. Une page contient jusqu'à page_size profils : pour la suivante, répétez l'appel avec les mêmes filtres, le session_id de la réponse et page plus un. Compte dans la limite de la Query API de 60 requêtes par heure.
- Lister les annotationsGETListe les annotations du projet, les notes épinglées à une date sur ses graphiques, avec id, date, description, auteur et tags.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
