gfwapiclient.resources.events.stats.endpoints

Global Fishing Watch (GFW) API Python Client - Events Statistics API Endpoints.

Module Contents

Classes

EventStatsEndPoint

Get Events Statistics API endpoint.

Data

__all__

API

gfwapiclient.resources.events.stats.endpoints.__all__ = ['EventStatsEndPoint']

class gfwapiclient.resources.events.stats.endpoints.EventStatsEndPoint(*, request_body: gfwapiclient.resources.events.stats.models.request.EventStatsBody, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.PostEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.resources.events.stats.models.request.EventStatsBody, gfwapiclient.resources.events.stats.models.response.EventStatsItem, gfwapiclient.resources.events.stats.models.response.EventStatsResult]

Get Events Statistics API endpoint.

This endpoint allows you to retrieve statistical information about events based on specified request body parameters.

Initialization

Initializes a new EventStatsEndPoint API endpoint.

Args:

request_body (EventStatsBody):

The request body containing the statistics parameters.

http_client (HTTPClient):

The HTTP client.