stats

Module for API stats counters.

See also

xbrl_filings_api.downloader.stats

Stats for the downloader subpackage.

Module Attributes

query_call_counter	Count of query calls started since the library was first imported.
api_query_counter	Count of API queries started since the library was first imported.
page_counter	Count of pages received since the library was first imported.

xbrl_filings_api.stats.query_call_counter = 0

Count of query calls started since the library was first imported.

This is the number of calls to query methods such as get_filings(). A query call consists of one or more API queries (multiple in case of multifilters) which in turn consist of pages.

xbrl_filings_api.stats.api_query_counter = 0

Count of API queries started since the library was first imported.

An API query is a set of URL parameters used to demand certain kind of content from the API. A call to method such as get_filings() may consist of multiple API queries in case of multifilter values or short dates. An API query consists of one or more pages.

xbrl_filings_api.stats.page_counter = 0

Count of pages received since the library was first imported.

A page is a received HTTP response. A single API query may consist of multiple pages.