Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Authy Reporting API


(warning)

Warning

As of November 2022, Twilio no longer provides support for Authy SMS/Voice-only customers. Customers who were also using Authy TOTP or Push prior to March 1, 2023 are still supported. The Authy API is now closed to new customers and will be fully deprecated in the future.

For new development, we encourage you to use the Verify v2 API.

Existing customers will not be impacted at this time until Authy API has reached End of Life. For more information about migration, see Migrating from Authy to Verify for SMS(link takes you to an external page).

The Authy Reporting API offers powerful query capability to get detailed information about your application usage. The API has three report type endpoints:

  1. Events
  2. Date Histogram
  3. Terms

Events

events page anchor

_10
GET https://api.authy.com/protected/{FORMAT}/reporting/events

URL

events-url page anchor
NameDescription
FORMAT StringThe format to expect back from the REST API call. json or xml.
NameDescription
query String (optional)Query to filter list of events in response. Default is everything. See query format (📇 PII)
page Integer (optional)Page within paginated results to display. Default is 1. (🏢 not PII )
per_page Integer (optional)Number of events to display per request. Default is 50. Maximum is 100. (🏢 not PII )

Response will either be in json or xml format depending on the format provided in the URL

NameDescription
success BooleanReturns true if the request was successful. (🏢 not PII )
events ArrayList of event objects. Each event contains the following fields:-event: name of the event.-time: time of the event in ISO8601 format.-request_id: UUID of the request.-objects: additional information about the event.See examples for more details. (📇 PII)
(warning)

Warning

Use the -g (same as --globoff) option to switch off the "URL globbing parser" and allow cURL to process the square brackets in the query parameters.

Events Reporting API Example

events-reporting-api-example page anchor

Example shows Push Authentication responses from iPhones

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/events?query[event][eq]=one_touch_request_responded&query[objects.device.s_device_type][eq]=iphone&page=1&per_page=50" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_103
{
_103
"events":[
_103
{
_103
"event":"one_touch_request_responded",
_103
"time":"2019-09-13T21:51:42.262Z",
_103
"request_id":"EB03D0F0-1234-5678-9101-F5014BD54354",
_103
"objects":{
_103
"app":{
_103
"b_custom_code_allowed":false,
_103
"b_custom_message_allowed":false,
_103
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_103
"s_device_app":null,
_103
"s_errors":"",
_103
"s_id":"12345",
_103
"s_name":"Demo Authy App",
_103
"s_type":"full"
_103
},
_103
"device":{
_103
"s_device_app":"authy",
_103
"s_device_type":"iphone",
_103
"s_errors":"",
_103
"s_id":"107469574",
_103
"s_ip":"IPv4_e123456789a28f09e7a02",
_103
"s_user_agent":"Authy 22.0 rv:99 (iPhone; iOS 12.0; en_US)",
_103
"s_version":"22.7",
_103
"t_creation_date":"2018-10-26T17:52:14.029Z",
_103
"t_last_used_date":"2019-09-06T05:31:24.030Z",
_103
"t_sync_date":"2019-09-13T21:49:06.463Z"
_103
},
_103
"onetouch_request":{
_103
"i_device_signing_time":0,
_103
"i_expiration_timestamp":1568497741,
_103
"i_seconds_to_expire":86400,
_103
"s_device_geolocation":null,
_103
"s_errors":"",
_103
"s_status":"denied",
_103
"s_uuid":"389b68e0-b89e-0137-546f-0a5fffce63e2"
_103
},
_103
"user":{
_103
"as_authy_ids":[
_103
"11123"
_103
],
_103
"b_banned":false,
_103
"s_authy_id":"11123",
_103
"s_country_code":"1",
_103
"s_errors":"",
_103
"s_locale":"en",
_103
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_103
}
_103
}
_103
},
_103
{
_103
"event":"one_touch_request_responded",
_103
"time":"2019-09-11T21:59:24.105Z",
_103
"request_id":"70D5FCF4-1234-5678-9101-9793BF7964D2",
_103
"objects":{
_103
"app":{
_103
"b_custom_code_allowed":false,
_103
"b_custom_message_allowed":false,
_103
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_103
"s_device_app":null,
_103
"s_errors":"",
_103
"s_id":"12345",
_103
"s_name":"Demo Authy App",
_103
"s_type":"full"
_103
},
_103
"device":{
_103
"s_device_app":"authy",
_103
"s_device_type":"iphone",
_103
"s_errors":"",
_103
"s_id":"107469574",
_103
"s_ip":"IPv4_e123456789a28f09e7a02",
_103
"s_user_agent":"Authy 22.0 rv:99 (iPhone; iOS 12.0; en_US)",
_103
"s_version":"22.7",
_103
"t_creation_date":"2018-10-26T17:52:14.029Z",
_103
"t_last_used_date":"2019-09-06T05:31:24.030Z",
_103
"t_sync_date":"2019-09-13T21:49:06.463Z"
_103
},
_103
"onetouch_request":{
_103
"i_device_signing_time":0,
_103
"i_expiration_timestamp":1568325203,
_103
"i_seconds_to_expire":86400,
_103
"s_device_geolocation":null,
_103
"s_errors":"",
_103
"s_status":"approved",
_103
"s_uuid":"800a6240-b70c-0137-5285-02ad8be0ad1a"
_103
},
_103
"user":{
_103
"as_authy_ids":[
_103
"11123"
_103
],
_103
"b_banned":false,
_103
"s_authy_id":"11123",
_103
"s_country_code":"1",
_103
"s_errors":"",
_103
"s_locale":"en",
_103
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_103
}
_103
}
_103
}
_103
],
_103
"success":true
_103
}

Queries to the Events Reporting API follow the following pattern:


_10
:query[:attribute][:operator]=:value

Supported Attributes and Available Events

supported-attributes-and-available-events page anchor

Report queries can be filtered by the following events:

The following events are specific to our legacy phone verification API. Please consider upgrading to Verify V2:

Queries can filter based on top level event details like name:


_10
query[event][eq]=one_touch_request_responded

Queries can also filter based on nested parameters like device type:


_10
query[objects.device.s_device_type][eq]=iphone

Multiple queries in one request are supported:


_10
query[event][eq]=totp_token_sent&query[objects.user.s_locale][eq]=en

The following operators can be used to compare and filter event attributes.

OperatorDescription
eqEqual to
ltLess than
lteLess than or Equal to
gtGreater than
gteGreater than or Equal to
lkLike or similar to

Date Histogram Reporting API Example

date-histogram-reporting-api-example page anchor

Example shows user_added events over time

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/date_histogram?report[users_added][event][eq]=user_added&interval=month&page=1&per_page=10" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_58
{
_58
"interval":"month",
_58
"reports":{
_58
"users_added":[
_58
{
_58
"timestamp":1517443200000,
_58
"time":"2018-02-01T00:00:00.000Z",
_58
"count":45
_58
},
_58
{
_58
"timestamp":1519862400000,
_58
"time":"2018-03-01T00:00:00.000Z",
_58
"count":74
_58
},
_58
{
_58
"timestamp":1525132800000,
_58
"time":"2018-05-01T00:00:00.000Z",
_58
"count":23
_58
},
_58
{
_58
"timestamp":1527811200000,
_58
"time":"2018-06-01T00:00:00.000Z",
_58
"count":100
_58
},
_58
{
_58
"timestamp":1530403200000,
_58
"time":"2018-07-01T00:00:00.000Z",
_58
"count":30004
_58
},
_58
{
_58
"timestamp":1533081600000,
_58
"time":"2018-08-01T00:00:00.000Z",
_58
"count":634
_58
},
_58
{
_58
"timestamp":1538352000000,
_58
"time":"2018-10-01T00:00:00.000Z",
_58
"count":43
_58
},
_58
{
_58
"timestamp":1543622400000,
_58
"time":"2018-12-01T00:00:00.000Z",
_58
"count":1
_58
},
_58
{
_58
"timestamp":1546300800000,
_58
"time":"2019-01-01T00:00:00.000Z",
_58
"count":45
_58
},
_58
{
_58
"timestamp":1548979200000,
_58
"time":"2019-02-01T00:00:00.000Z",
_58
"count":65
_58
}
_58
]
_58
},
_58
"success":true
_58
}


The following endpoint uses the querier service to return summaries over time of the queried events.


_10
GET https://api.authy.com/protected/{FORMAT}/reporting/date_histogram

NameDescription
FORMAT StringThe format to expect back from the REST API call. json or xml.
NameDescription
report[:report_name][:attribute][:operator] String (required)Defines the queries to run, no reports returned if omitted. -:report_name: your name for the report summary-:attribute: See query format-:operator: See supported operators(📇 PII)
interval String (optional)Default is "month". Allowed values are: -year-quarter-month-week-day-hour-minuteInterval also supports time settings like "1.5h" (up to "w" for weeks).
scope[:attribute][:operator] String (optional)Defines a filter for the query. Multiple scopes are supported. For example scope[user.authy_id][eq]=123 will only return results for that user. See query format and supported operators. (📇 PII)
page Integer (optional)Page within paginated results to display. Default is 1. (🏢 not PII )
per_page Integer (optional)Number of events to display per request. Default is 50. Maximum is 100. (🏢 not PII )

Response will either be in json or xml format depending on the format provided in the URL

NameDescription
success BooleanReturns true if the request was successful. (🏢 not PII )
reports ArrayList of report objects. Each report contains the following fields-timestamp: interval timestamp in Epoch format.-time: interval time in ISO8601 format.-count: number of times the event occurred in the interval. (🏢 not PII )

Terms Reporting API Example

terms-reporting-api-example page anchor

Example shows aggregated summary of events by name for 2019

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/terms?field=event&scope[time][gte]=2019-01-01T00:00:00.000Z&scope[time][lt]=2020-01-01T00:00:00.000Z" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_29
{
_29
"terms":[
_29
{
_29
"key":"one_touch_request_responded",
_29
"count":667
_29
},
_29
{
_29
"key":"totp_token_sent",
_29
"count":362
_29
},
_29
{
_29
"key":"token_verified",
_29
"count":164
_29
},
_29
{
_29
"key":"token_invalid",
_29
"count":155
_29
},
_29
{
_29
"key":"user_added",
_29
"count":81
_29
},
_29
{
_29
"key":"user_removed",
_29
"count":53
_29
}
_29
],
_29
"success":true
_29
}


The following endpoint groups by field to roll-up summaries of specific attributes.


_10
GET https://api.authy.com/protected/{FORMAT}/reporting/terms

NameDescription
FORMAT StringThe format to expect back from the REST API call. json or xml.
NameDescription
field String (required)Defines the attribute to group by. Only one field is supported per query. Queries can group by top level event details like name (event) or nested parameters like device type (objects.device.s_device_type). For a list of supported events and their fields, see Supported Attributes. (📇 PII)
size Integer (optional)Number of terms to return. Default is 10. Maximum is 100. (🏢 not PII )
scope[:attribute][:operator] String (optional)Defines a filter for the query. Multiple scopes are supported. For example scope[user.authy_id][eq]=123 will only return results for that user. See query format and supported operators. (📇 PII)

Response will either be in json or xml format depending on the format provided in the URL

NameDescription
success BooleanReturns true if the request was successful. (🏢 not PII )
terms ArrayList of term objects. Each term contains the following fields-key: field grouping (String)-count: number of occurrences within the scope (Integer) (🏢 not PII )
(warning)

Warning

Seeing this error?

[globbing] bad range in column

Make sure to use the -g (same as --globoff) option to switch off the "URL globbing parser" and allow cURL to process the square brackets in the query parameters.

Events: Get logs from December 17, 2019

events-get-logs-from-december-17-2019 page anchor

Use gte and lte operators to filter date ranges

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/events?query[time][gte]=2019-12-17T00:00:00.000Z&query[time][lte]=2019-12-17T23:59:59.999Z" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_89
{
_89
"events":[
_89
{
_89
"event":"totp_token_sent",
_89
"time":"2019-12-17T20:32:23.601Z",
_89
"request_id":"foo06a5ed13a1234567890ec30458e104",
_89
"objects":{
_89
"app":{
_89
"b_custom_code_allowed":false,
_89
"b_custom_message_allowed":false,
_89
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_89
"s_device_app":null,
_89
"s_errors":"",
_89
"s_id":"12345",
_89
"s_name":"Demo Authy App",
_89
"s_type":"full"
_89
},
_89
"user":{
_89
"as_authy_ids":[
_89
"11123"
_89
],
_89
"b_banned":false,
_89
"s_authy_id":"11123",
_89
"s_country_code":"1",
_89
"s_errors":"",
_89
"s_locale":"en",
_89
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_89
}
_89
}
_89
},
_89
{
_89
"event":"totp_token_sent",
_89
"time":"2019-12-17T20:27:32.189Z",
_89
"request_id":"bar06a5ed13a1234567890ec30458e501",
_89
"objects":{
_89
"app":{
_89
"b_custom_code_allowed":false,
_89
"b_custom_message_allowed":false,
_89
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_89
"s_device_app":null,
_89
"s_errors":"",
_89
"s_id":"12345",
_89
"s_name":"Demo Authy App",
_89
"s_type":"full"
_89
},
_89
"user":{
_89
"as_authy_ids":[
_89
"11123"
_89
],
_89
"b_banned":false,
_89
"s_authy_id":"11123",
_89
"s_country_code":"1",
_89
"s_errors":"",
_89
"s_locale":"en",
_89
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_89
}
_89
}
_89
},
_89
{
_89
"event":"user_added",
_89
"time":"2019-12-17T20:22:24.556Z",
_89
"request_id":"baz06a5ed13a1234567890ec30458e501",
_89
"objects":{
_89
"app":{
_89
"b_custom_code_allowed":false,
_89
"b_custom_message_allowed":false,
_89
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_89
"s_device_app":null,
_89
"s_errors":"",
_89
"s_id":"12345",
_89
"s_name":"Demo Authy App",
_89
"s_type":"full"
_89
},
_89
"user":{
_89
"as_authy_ids":[
_89
"11123"
_89
],
_89
"b_banned":false,
_89
"s_authy_id":"11123",
_89
"s_country_code":"1",
_89
"s_errors":"",
_89
"s_locale":"en",
_89
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_89
}
_89
}
_89
}
_89
],
_89
"success":true
_89
}

Events: Authentication Details Q2 2019

events-authentication-details-q2-2019 page anchor

Returns all token events for March, April, and May. Page 2 with 5 results per page.

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/events?query[time][gte]=2019-04-01T00:00:00.000Z&query[time][lt]=2019-07-01T00:00:00.000Z&page=2&per_page=5" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_180
{
_180
"events":[
_180
{
_180
"event":"one_touch_request_responded",
_180
"time":"2019-04-03T21:15:11.193Z",
_180
"request_id":"6FCA925A-9D07-4DFE-B160-84A760A7620C",
_180
"objects":{
_180
"app":{
_180
"b_custom_code_allowed":false,
_180
"b_custom_message_allowed":false,
_180
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_180
"s_device_app":null,
_180
"s_errors":"",
_180
"s_id":"12345",
_180
"s_name":"Demo Authy App",
_180
"s_type":"full"
_180
},
_180
"device":{
_180
"s_device_app":"authy",
_180
"s_device_type":"iphone",
_180
"s_errors":"",
_180
"s_id":"107469574",
_180
"s_ip":"IPv4_e123456789a28f09e7a02",
_180
"s_user_agent":"Authy 22.0 rv:99 (iPhone; iOS 12.0; en_US)",
_180
"s_version":"22.7",
_180
"t_creation_date":"2018-10-26T17:52:14.029Z",
_180
"t_last_used_date":"2019-09-06T05:31:24.030Z",
_180
"t_sync_date":"2019-09-13T21:49:06.463Z"
_180
},
_180
"onetouch_request":{
_180
"i_device_signing_time":0,
_180
"i_expiration_timestamp":1568497741,
_180
"i_seconds_to_expire":86400,
_180
"s_device_geolocation":null,
_180
"s_errors":"",
_180
"s_status":"denied",
_180
"s_uuid":"389b68e0-b89e-0137-546f-0a5fffce63e2"
_180
},
_180
"user":{
_180
"as_authy_ids":[
_180
"11123"
_180
],
_180
"b_banned":false,
_180
"s_authy_id":"11123",
_180
"s_country_code":"1",
_180
"s_errors":"",
_180
"s_locale":"en",
_180
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_180
}
_180
}
_180
},
_180
{
_180
"event":"one_touch_request_responded",
_180
"time":"2019-04-03T21:14:16.777Z",
_180
"request_id":"859CA085-6353-4925-AD69-911CB1256BCA",
_180
"objects":{
_180
"app":{
_180
"b_custom_code_allowed":false,
_180
"b_custom_message_allowed":false,
_180
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_180
"s_device_app":null,
_180
"s_errors":"",
_180
"s_id":"12345",
_180
"s_name":"Demo Authy App",
_180
"s_type":"full"
_180
},
_180
"device":{
_180
"s_device_app":"authy",
_180
"s_device_type":"iphone",
_180
"s_errors":"",
_180
"s_id":"107469574",
_180
"s_ip":"IPv4_e123456789a28f09e7a02",
_180
"s_user_agent":"Authy 22.0 rv:99 (iPhone; iOS 12.0; en_US)",
_180
"s_version":"22.7",
_180
"t_creation_date":"2018-10-26T17:52:14.029Z",
_180
"t_last_used_date":"2019-09-06T05:31:24.030Z",
_180
"t_sync_date":"2019-09-13T21:49:06.463Z"
_180
},
_180
"onetouch_request":{
_180
"i_device_signing_time":0,
_180
"i_expiration_timestamp":1568497741,
_180
"i_seconds_to_expire":86400,
_180
"s_device_geolocation":null,
_180
"s_errors":"",
_180
"s_status":"denied",
_180
"s_uuid":"389b68e0-b89e-0137-546f-0a5fffce63e2"
_180
},
_180
"user":{
_180
"as_authy_ids":[
_180
"11123"
_180
],
_180
"b_banned":false,
_180
"s_authy_id":"11123",
_180
"s_country_code":"1",
_180
"s_errors":"",
_180
"s_locale":"en",
_180
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_180
}
_180
}
_180
},
_180
{
_180
"event":"token_verified",
_180
"time":"2019-04-03T19:58:41.978Z",
_180
"request_id":"b058ce28cfddcbadeabda9a10f93f6a6",
_180
"objects":{
_180
"app":{
_180
"b_custom_code_allowed":false,
_180
"b_custom_message_allowed":false,
_180
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_180
"s_device_app":null,
_180
"s_errors":"",
_180
"s_id":"12345",
_180
"s_name":"Demo Authy App",
_180
"s_type":"full"
_180
},
_180
"token":{
_180
"s_id":"75512345",
_180
"s_type":"SmsToken"
_180
},
_180
"user":{
_180
"as_authy_ids":[
_180
"11123"
_180
],
_180
"b_banned":false,
_180
"s_authy_id":"11123",
_180
"s_country_code":"1",
_180
"s_errors":"",
_180
"s_locale":"en",
_180
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_180
}
_180
}
_180
},
_180
{
_180
"event":"totp_token_sent",
_180
"time":"2019-04-03T19:58:29.403Z",
_180
"request_id":"3dbcc130b48294c7abb1ef94dfbb2710",
_180
"objects":{
_180
"app":{
_180
"b_custom_code_allowed":false,
_180
"b_custom_message_allowed":false,
_180
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_180
"s_device_app":null,
_180
"s_errors":"",
_180
"s_id":"12345",
_180
"s_name":"Demo Authy App",
_180
"s_type":"full"
_180
},
_180
"user":{
_180
"as_authy_ids":[
_180
"11123"
_180
],
_180
"b_banned":false,
_180
"s_authy_id":"11123",
_180
"s_country_code":"1",
_180
"s_errors":"",
_180
"s_locale":"en",
_180
"s_phone_number":"ce65dc3e20xxxxxxxxxxxxxxxxc56ddee10071"
_180
}
_180
}
_180
},
_180
{
_180
"event":"too_many_code_verifications",
_180
"time":"2019-03-19T21:15:33.2Z",
_180
"request_id":"44f1a17d42bb458bd4c74928fc20b445",
_180
"objects":{
_180
"app":{
_180
"b_custom_code_allowed":false,
_180
"b_custom_message_allowed":false,
_180
"s_account_sid":"ACxxxxxxxxxxxxxxxxx",
_180
"s_device_app":null,
_180
"s_errors":"",
_180
"s_id":"12345",
_180
"s_name":"Demo Authy App",
_180
"s_type":"full"
_180
}
_180
}
_180
}
_180
],
_180
"success":true
_180
}

Date Histogram: Get Invalid Tokens and Valid Tokens over time

date-histogram-get-invalid-tokens-and-valid-tokens-over-time page anchor

Multiple reports in one request are supported

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/date_histogram?interval=month&report[verified_tokens][event][eq]=token_verified&report[invalid_tokens][event][eq]=token_invalid" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_170
{
_170
"interval":"month",
_170
"reports":{
_170
"invalid_tokens":[
_170
{
_170
"timestamp":1517443200000,
_170
"time":"2018-02-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1519862400000,
_170
"time":"2018-03-01T00:00:00.000Z",
_170
"count":4
_170
},
_170
{
_170
"timestamp":1525132800000,
_170
"time":"2018-05-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1527811200000,
_170
"time":"2018-06-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1530403200000,
_170
"time":"2018-07-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1533081600000,
_170
"time":"2018-08-01T00:00:00.000Z",
_170
"count":2
_170
},
_170
{
_170
"timestamp":1538352000000,
_170
"time":"2018-10-01T00:00:00.000Z",
_170
"count":1
_170
},
_170
{
_170
"timestamp":1543622400000,
_170
"time":"2018-12-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1546300800000,
_170
"time":"2019-01-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1548979200000,
_170
"time":"2019-02-01T00:00:00.000Z",
_170
"count":3
_170
},
_170
{
_170
"timestamp":1551398400000,
_170
"time":"2019-03-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1554076800000,
_170
"time":"2019-04-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1556668800000,
_170
"time":"2019-05-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1559347200000,
_170
"time":"2019-06-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1567296000000,
_170
"time":"2019-09-01T00:00:00.000Z",
_170
"count":1
_170
},
_170
{
_170
"timestamp":1569888000000,
_170
"time":"2019-10-01T00:00:00.000Z",
_170
"count":0
_170
}
_170
],
_170
"verified_tokens":[
_170
{
_170
"timestamp":1517443200000,
_170
"time":"2018-02-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1519862400000,
_170
"time":"2018-03-01T00:00:00.000Z",
_170
"count":7
_170
},
_170
{
_170
"timestamp":1525132800000,
_170
"time":"2018-05-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1527811200000,
_170
"time":"2018-06-01T00:00:00.000Z",
_170
"count":4
_170
},
_170
{
_170
"timestamp":1530403200000,
_170
"time":"2018-07-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1533081600000,
_170
"time":"2018-08-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1538352000000,
_170
"time":"2018-10-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1543622400000,
_170
"time":"2018-12-01T00:00:00.000Z",
_170
"count":5
_170
},
_170
{
_170
"timestamp":1546300800000,
_170
"time":"2019-01-01T00:00:00.000Z",
_170
"count":3
_170
},
_170
{
_170
"timestamp":1548979200000,
_170
"time":"2019-02-01T00:00:00.000Z",
_170
"count":3
_170
},
_170
{
_170
"timestamp":1551398400000,
_170
"time":"2019-03-01T00:00:00.000Z",
_170
"count":1
_170
},
_170
{
_170
"timestamp":1554076800000,
_170
"time":"2019-04-01T00:00:00.000Z",
_170
"count":1
_170
},
_170
{
_170
"timestamp":1556668800000,
_170
"time":"2019-05-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1559347200000,
_170
"time":"2019-06-01T00:00:00.000Z",
_170
"count":0
_170
},
_170
{
_170
"timestamp":1567296000000,
_170
"time":"2019-09-01T00:00:00.000Z",
_170
"count":12
_170
},
_170
{
_170
"timestamp":1569888000000,
_170
"time":"2019-10-01T00:00:00.000Z",
_170
"count":0
_170
}
_170
]
_170
},
_170
"success":true
_170
}

Date Histogram: Verified Tokens with Scope

date-histogram-verified-tokens-with-scope page anchor

Summary of verified tokens for a specific 3 month range

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/date_histogram?scope[time][gte]=2019-04-01T00:00:00.000Z&scope[time][lt]=2019-07-01T00:00:00.000Z&report[verified_tokens][event][eq]=token_verified" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_23
{
_23
"interval":"month",
_23
"reports":{
_23
"verified_tokens":[
_23
{
_23
"timestamp":1554076800000,
_23
"time":"2019-04-01T00:00:00.000Z",
_23
"count":56
_23
},
_23
{
_23
"timestamp":1556668800000,
_23
"time":"2019-05-01T00:00:00.000Z",
_23
"count":129
_23
},
_23
{
_23
"timestamp":1559347200000,
_23
"time":"2019-06-01T00:00:00.000Z",
_23
"count":543
_23
}
_23
]
_23
},
_23
"success":true
_23
}

Terms: Monthly Active Users

terms-monthly-active-users page anchor

Summary of authentications by Authy ID for November 2019. 'key' is the Authy ID.

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/terms?field=objects.user.s_authy_id&scope[time][gte]=2019-11-01T00:00:00.000Z&scope[time][lt]=2019-12-01T00:00:00.000Z" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_28
{
_28
"terms":[
_28
{
_28
"key":"123",
_28
"count":99
_28
},
_28
{
_28
"key":"321",
_28
"count":197
_28
},
_28
{
_28
"key":"452",
_28
"count":1
_28
},
_28
{
_28
"key":"942",
_28
"count":140005
_28
},
_28
{
_28
"key":"23",
_28
"count":14
_28
{
_28
"key":"6792",
_28
"count":5
_28
}
_28
],
_28
"success":true
_28
}

Terms: Authentications by Device Type

terms-authentications-by-device-type page anchor

Summary of authentications by device type for all of 2019. 'key' is the device type.

curl

_10
curl -g \
_10
"https://api.authy.com/protected/json/reporting/terms?field=objects.device.s_device_type&scope[time][gte]=2019-01-01T00:00:00.000Z&scope[time][lt]=2020-01-01T00:00:00.000Z" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_17
{
_17
"terms":[
_17
{
_17
"key":"iphone",
_17
"count":43823
_17
},
_17
{
_17
"key":"android",
_17
"count":2390235
_17
},
_17
{
_17
"key":"chrome",
_17
"count":145
_17
}
_17
],
_17
"success":true
_17
}

Rate limits are enforced by the Authy API. If your application hits the rate limit, an error will be returned and the app will be temporarily suspended.

LimitTimeContext
30per minuteper application
300per hourper application

Rate this Page: