metrics_api module#

class edgeimpulse_api.api.metrics_api.MetricsApi(api_client=None)[source]#

Bases: object

get_public_metrics(
**kwargs,
) → GetPublicMetricsResponse[source]#

Get public metrics

Get information about number of projects, compute and data samples. Updated once per hour.

Parameters:

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetPublicMetricsResponse

log_analytics_event(
log_analytics_event_request: LogAnalyticsEventRequest,
**kwargs,
) → GenericApiResponse[source]#

Log analytics event

Log an analytics event.

Parameters:

  • log_analytics_event_request (LogAnalyticsEventRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

log_website_pageview(
log_website_pageview_request: LogWebsitePageviewRequest,
**kwargs,
) → GenericApiResponse[source]#

Log website pageview

Log a website pageview. Used for website analytics.

Parameters:

  • log_website_pageview_request (LogWebsitePageviewRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse