get_usage_stats: Retrive 24 hour scan statistics from the TLS Obsercatory API

Description Usage Arguments Value References Examples

Description

Retrive 24 hour scan statistics from the TLS Obsercatory API

Usage

1
get_usage_stats(host = get_obs_host(), timeout = 60)

Arguments

host

if you host your own instance of the TLS Observatory, either specify the hostname here (not advised) or set the envrionment variable TLS_OBSERVATORY_HOST to the hostname (preferred). If no environment variable is set the default ("tls-observatory.services.mozilla.com") will be used.

timeout

defaults to 60 seconds as the endpoint seems to issue a SQL query for every call vs cache data. Adjust as necessary (ie. when the server is under load this might need to be increased).

Value

a list with a data.frame of scan counts for the past 24 hours and other metadata fields.

References

https://github.com/mozilla/tls-observatory#get-apiv1stats

Examples

1

hrbrmstr/tlsobs documentation built on May 20, 2019, 4:06 p.m.