kavita_client.api.stats.get_api_stats_most_active_users

Module Contents

Functions

asyncio	Top 5 most active readers for the given timeframe
asyncio_detailed	Top 5 most active readers for the given timeframe
sync	Top 5 most active readers for the given timeframe
sync_detailed	Top 5 most active readers for the given timeframe

API

async kavita_client.api.stats.get_api_stats_most_active_users.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, start_date: datetime.datetime | kavita_client.types.Unset = UNSET, time_zone_id: str | kavita_client.types.Unset = UNSET, end_date: datetime.datetime | kavita_client.types.Unset = UNSET, libraries: list[int] | kavita_client.types.Unset = UNSET) → list[kavita_client.models.top_read_dto.TopReadDto] | None

Top 5 most active readers for the given timeframe

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[TopReadDto]

async kavita_client.api.stats.get_api_stats_most_active_users.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, start_date: datetime.datetime | kavita_client.types.Unset = UNSET, time_zone_id: str | kavita_client.types.Unset = UNSET, end_date: datetime.datetime | kavita_client.types.Unset = UNSET, libraries: list[int] | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.top_read_dto.TopReadDto]]

Top 5 most active readers for the given timeframe

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[TopReadDto]]

kavita_client.api.stats.get_api_stats_most_active_users.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, start_date: datetime.datetime | kavita_client.types.Unset = UNSET, time_zone_id: str | kavita_client.types.Unset = UNSET, end_date: datetime.datetime | kavita_client.types.Unset = UNSET, libraries: list[int] | kavita_client.types.Unset = UNSET) → list[kavita_client.models.top_read_dto.TopReadDto] | None

Top 5 most active readers for the given timeframe

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[TopReadDto]

kavita_client.api.stats.get_api_stats_most_active_users.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, start_date: datetime.datetime | kavita_client.types.Unset = UNSET, time_zone_id: str | kavita_client.types.Unset = UNSET, end_date: datetime.datetime | kavita_client.types.Unset = UNSET, libraries: list[int] | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.top_read_dto.TopReadDto]]

Top 5 most active readers for the given timeframe

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[TopReadDto]]