kavita_client.api.stats.get_api_stats_reads_by_month

Module Contents

Functions

asyncio	Args: start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): 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: list[YearMonthGroupingDtoStatCount]
asyncio_detailed	Args: start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): 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[list[YearMonthGroupingDtoStatCount]]
sync	Args: start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): 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: list[YearMonthGroupingDtoStatCount]
sync_detailed	Args: start_date (datetime.datetime | Unset): time_zone_id (str | Unset): end_date (datetime.datetime | Unset): libraries (list[int] | Unset): 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[list[YearMonthGroupingDtoStatCount]]

API

async kavita_client.api.stats.get_api_stats_reads_by_month.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, user_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.year_month_grouping_dto_stat_count.YearMonthGroupingDtoStatCount] | None

Args:

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

list[YearMonthGroupingDtoStatCount]

async kavita_client.api.stats.get_api_stats_reads_by_month.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, user_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.year_month_grouping_dto_stat_count.YearMonthGroupingDtoStatCount]]

Args:

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

kavita_client.api.stats.get_api_stats_reads_by_month.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, user_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.year_month_grouping_dto_stat_count.YearMonthGroupingDtoStatCount] | None

Args:

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

list[YearMonthGroupingDtoStatCount]

kavita_client.api.stats.get_api_stats_reads_by_month.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, user_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.year_month_grouping_dto_stat_count.YearMonthGroupingDtoStatCount]]

Args:

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