This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
Ctrlk
HomeDocumentation
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Insights

Interrogez les journaux, les événements et les métriques de The Wallet Crew avec Kusto Query Language.

API Insights

Le API Insights donne accès à la base de données d’utilisation de The Wallet Crew. Interrogez les journaux, les événements et les métriques à l’aide de Langage de requête Kusto (KQL).

Cette API est conçue pour les équipes techniques qui extraient des données par programmation.

Exemples concrets

  • Interrogez les tendances d’installation de Carte par jour après le lancement d’une campagne.

  • Exportez l’activité des webhooks ou des scans dans un pipeline BI.

  • Inspectez les journaux de la plateforme lors du débogage d’un problème d’intégration spécifique à un locataire.

Authentification et autorisations

L’accès nécessite l’authentification standard de The Wallet Crew.

  • Autorisation requise : Insights:Read

  • Flux d’authentification : utilisez un jeton d’authentification The Wallet Crew existant (par exemple, obtenu via une connexion ou un service à service).

  • Portée mono-locataire : vous ne pouvez interroger que les données de votre propre locataire.

Envoyez le jeton d’accès via le Authorization .

Rétention et limites de débit

  • Journaux: conservés 45 jours

  • Événements: conservés indéfiniment

  • Métriques: conservés indéfiniment

Limite de débit: 60 appels API par minute. Pour demander des limites plus élevées, ouvrez un ticket d’assistance.

Point de terminaison

Toutes les requêtes utilisent cette opération :

Execute analytics query

post
/api/{tenantId}/insights/query

Runs a custom analytics query and returns results in tabular format.

Authorization

Requires Insights.Read scope.

Rate Limiting

Limited to 60 requests per interval to protect analytics infrastructure.

Query Language

Typically uses Kusto Query Language (KQL) syntax:

Passes
| where timestamp > ago(7d)
| summarize count() by passType
| order by count_ desc

Parameters

Supports parameterized queries for security and reusability:

{
  "query": "Events | where Name == name | take 100",
  "parameters": { "name": "Pass:Installed" }
}

Use Cases

  • Custom dashboards

  • Business intelligence reports

  • Data exports

  • Trend analysis

Performance

  • Query timeout: Configurable per tenant

  • Result limits: May be enforced

  • Caching: Not automatic - implement client-side if needed

Scopes requis
Cet endpoint nécessite les scopes suivants :
Autorisations
OAuth2implicitRequis
Authorization URL:
Paramètres de chemin
tenantIdstringRequis
Corps
querystringRequis
optionsobject · Neo.Web.Api.Insights.Controllers.InsightsController.QueryRequest.QueryOptionsOptionnel
Réponses
200

Query executed successfully

columnsstring[]Optionnel
post/api/{tenantId}/insights/query

  • {tenantId} = votre identifiant de locataire

  • Le corps de la requête doit contenir une requête chaîne en KQL

Tables et schéma

La base de données Insights contient trois tables :

Journaux

Colonne
Type

eventId

guid

timestamp

datetime

tenantId

string

eventType

string

operationId

string

properties

dynamic

Contient des erreurs et des traces liées à l’activité de la plateforme. Utile pour le débogage et la surveillance de l’état de santé.

Événements

Colonne
Type

eventId

guid

timestamp

datetime

tenantId

string

eventType

string

operationId

string

properties

dynamic

Contient :

  • Vues de page

  • Requêtes API

  • Événements métier personnalisés

Métriques

Colonne
Type

metricId

guid

tenantId

string

metricType

string

value

dynamic

properties

dynamic

timestamp

datetime

Représente des instantanés de l’état du système, pris toutes les heures.

Requêtes courantes

Compter les nouveaux clients

Compter les installations de Carte

Compter les requêtes par jour

Compter les redirections par jour

Compter les vues de page par navigateur

Types d’événements courants

Voici quelques-uns des eventType valeurs les plus courantes que vous souhaiterez peut-être interroger :

  • Cycle de vie du client

    • Customer:Upserted

    • Y2:Customer:Created

    • Y2:Customer:Updated

  • Cycle de vie de la Carte

    • Carte:Created

    • Carte:Updated

    • Carte:Installed

    • Carte:Uninstalled

  • Actions utilisateur

    • action:addToAppleWallet

    • action:addToGoogleWallet

    • action:loginWithGoogle

    • action:loginWithApple

  • Suivi et analytique

    • Request

    • PageView

    • Redirect:Redirected

    • step:complete

    • step:changed

Dépannage

  • 401 Non autorisé

    • Assurez-vous que votre jeton est valide et inclut Insights:Read.

  • 429 Trop de requêtes

    • Vous avez dépassé la limite de débit (60 appels/minute). Mettez en œuvre des réessais avec temporisation exponentielle.

  • La requête prend trop de temps

    • Simplifiez la requête ou réduisez la fenêtre temporelle.

    • Évitez les requêtes non bornées sur les grandes tables.

FAQ

Puis-je exporter les résultats en CSV/JSON ?

Pas directement via l’API.

Consommez la réponse JSON et convertissez-la localement.

Puis-je interroger plusieurs locataires ?

Non.

L’accès est limité à votre seul locataire.

La base de données Insights contient-elle des données personnelles ?

Non.

Elle ne contient pas de données personnelles identifiables.

Puis-je configurer des alertes (seuils, déclencheurs) ?

Pas pour le moment.

Mis à jour