kavita_client.api.stats.get_api_stats_reading_history

Module Contents

Functions

asyncio	Return a user’s reading session history
asyncio_detailed	Return a user’s reading session history
sync	Return a user’s reading session history
sync_detailed	Return a user’s reading session history

API

async kavita_client.api.stats.get_api_stats_reading_history.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, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.reading_history_item_dto.ReadingHistoryItemDto] | None

Return a user’s reading session history

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): page_number (int | Unset): page_size (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[ReadingHistoryItemDto]

async kavita_client.api.stats.get_api_stats_reading_history.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, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.reading_history_item_dto.ReadingHistoryItemDto]]

Return a user’s reading session history

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): page_number (int | Unset): page_size (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[ReadingHistoryItemDto]]

kavita_client.api.stats.get_api_stats_reading_history.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, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.reading_history_item_dto.ReadingHistoryItemDto] | None

Return a user’s reading session history

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): page_number (int | Unset): page_size (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[ReadingHistoryItemDto]

kavita_client.api.stats.get_api_stats_reading_history.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, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.reading_history_item_dto.ReadingHistoryItemDto]]

Return a user’s reading session history

Args:

start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): page_number (int | Unset): page_size (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[ReadingHistoryItemDto]]