Skip to content

Fetch Stats from Authentication Trials

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

This operation allows to retrieve from the API success rate statistics of authentication trial records that satisfied specified criteria.

Parameters

  • deststringoptional

    Filter authentication trials sent only to this phone number or email. The phone number must be in the E.164 format.

  • trialStatusstringoptional

    Filter authentication trials with the specified status. One of successful, or unsuccessful.

  • channelstringoptional

    Filter authentication trials sent via the specified channel. One of sms, or email.

  • configurationIdstringoptional

    Filter authentication trials from the configuration whose ID matches the specified one.

  • authenticationIdstringoptional

    Filter authentication trials from the authentication whose ID matches the specified one.

  • countrystringoptional

    Filter authentication trials sent to the specified destination country (in ISO 3166-1 alpha-2 format). Only possible when dest is a phone number.

  • sentAtdate-timeoptional

    Filter authentication trials generated at the specified date. Must be in ISO 8601 format.

  • sentAfterdate-timeoptional

    Filter authentication trials generated after the specified datetime. Must be in ISO 8601 format.

  • sentBeforedate-timeoptional

    Filter authentication trials generated before the specified datetime. Must be in ISO 8601 format.

Example 1: Fetch Authentication Trial Stats

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
}

Example 2: Fetch Authentication Trial Stats by Authentix ConfigurationId

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
}

Example 3: Fetch Authentication Trial Stats by Country

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
}