Skip to content

Consulter des statistiques d'essais d'authentification

get
https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrialStats

Cette opération permet d'extraire de l'API des statistiques sur le taux de réussite des essais d'authentification qui satisfont les critères spécifiés.

Paramètres

  • deststringoptional

    Filtrer les essais d'authentification envoyés uniquement à ce numéro de téléphone ou à cet e-mail. Le numéro de téléphone doit être au format E.164.

  • trialStatusstringoptional

    Filtre les essais d'authentification avec le statut spécifié. Au choix entre successful, ou unsuccessful.

  • channelstringoptional

    Filtre les essais d'authentification envoyés via le canal spécifié. Au choix entre sms, ou email.

  • configurationIdstringoptional

    Filtrer les essais d'authentification associés à la configuration dont l'ID correspond à celle spécifiée.

  • authenticationIdstringoptional

    Filtrer les essais d'authentification associés à l'authentification dont l'ID correspond à celle spécifiée.

  • countrystringoptional

    Filtre les essais d'authentification envoyés au pays de destination spécifié (en format ISO 3166-1 alpha-2). Uniquement possible lorsque dest est un numéro de téléphone.

  • sentAtdate-timeoptional

    Filtre les essais d'authentification générés à la date spécifiée. Doit être au format ISO 8601.

  • sentAfterdate-timeoptional

    Filtre les essais d'authentification générés après la date spécifiée. Doit être au format ISO 8601.

  • sentBeforedate-timeoptional

    Filtre les essais d'authentification générés avant la date spécifiée. Doit être au format ISO 8601.

Exemple 1: Consulter les statistiques des essais d'authentification

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrialStats -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "totalTrials": 15,
  "numSuccessfulTrials": 12,
  "numUnsuccessfulTrials": 3,
  "successRate": 0.8
}

Exemple 2: Consulter les statistiques des essais d'authentification par configuration

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrialStats?configurationId=CIDXXXXXXXXXXXX -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "totalTrials": 15,
  "numSuccessfulTrials": 12,
  "numUnsuccessfulTrials": 3,
  "successRate": 0.8
}

Exemple 3: Consulter les statistiques des essais d'authentification par pays

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrialStats?country=CM -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "totalTrials": 15,
  "numSuccessfulTrials": 12,
  "numUnsuccessfulTrials": 3,
  "successRate": 0.8
}