kavita_client.api.stats.get_api_stats_total_reads

Module Contents

Functions

asyncio	Returns the total amount reads in the given filter
asyncio_detailed	Returns the total amount reads in the given filter
sync	Returns the total amount reads in the given filter
sync_detailed	Returns the total amount reads in the given filter

API

async kavita_client.api.stats.get_api_stats_total_reads.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET) → int | None

Returns the total amount reads in the given filter

Args:

user_id (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:

int

async kavita_client.api.stats.get_api_stats_total_reads.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[int]

Returns the total amount reads in the given filter

Args:

user_id (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[int]

kavita_client.api.stats.get_api_stats_total_reads.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET) → int | None

Returns the total amount reads in the given filter

Args:

user_id (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:

int

kavita_client.api.stats.get_api_stats_total_reads.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[int]

Returns the total amount reads in the given filter

Args:

user_id (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[int]