errors#

exception analytix.errors.AnalytixError#

The base exception class for analytix.

exception analytix.errors.MissingOptionalComponents(*args: str)#

Exception thrown when components not installed by analytix by default are required for a specific operation, but are not installed.

exception analytix.errors.APIError(code: str, message: str)#

Exception thrown when the YouTube Analytics API throws an error.

exception analytix.errors.DataFrameConversionError#

Exception thrown when converting a report to a DataFrame fails.

exception analytix.errors.InvalidRequest#

Exception thrown when a request to be made to the YouTube Analytics API is not valid.

exception analytix.errors.MissingMetrics#

Exception thrown when no metrics are provided. Inherits from InvalidRequest.

exception analytix.errors.InvalidMetrics(diff: set[str])#

Exception thrown when one or more metrics are not valid. Inherits from InvalidRequest.

exception analytix.errors.UnsupportedMetrics(diff: set[str])#

Exception thrown when one or more metrics are valid, but not compatible with the report type that has been selected. Inherits from InvalidRequest.

exception analytix.errors.MissingSortOptions#

Exception thrown when no sort options are provided when necessary. Inherits from InvalidRequest.

exception analytix.errors.InvalidSortOptions(diff: set[str])#

Exception thrown when one or more sort options are not valid. Inherits from InvalidRequest.

exception analytix.errors.UnsupportedSortOptions(diff: set[str], *, descending_only: bool = False)#

Exception thrown when one or more sort options are valid, but not compatible with the report type that has been selected. Inherits from InvalidRequest.

exception analytix.errors.InvalidDimensions(diff: set[str], depr: set[str])#

Exception thrown when one or more dimensions are not valid. Inherits from InvalidRequest.

exception analytix.errors.UnsupportedDimensions(diff: set[str])#

Exception thrown when one or more dimensions are valid, but not compatible with the report type that has been selected. Inherits from InvalidRequest.

exception analytix.errors.InvalidSetOfDimensions(expd: str, recv: int, values: set[str])#

Exception thrown when a set of dimensions contravenes the API specification. Inherits from InvalidRequest.

exception analytix.errors.InvalidFilters(diff: set[str])#

Exception thrown when one or more filters are not valid. Inherits from InvalidRequest.

exception analytix.errors.UnsupportedFilters(diff: set[str])#

Exception thrown when one or more filters are valid, but not compatible with the report type that has been selected. Inherits from InvalidRequest.

exception analytix.errors.InvalidSetOfFilters(expd: str, recv: int, values: set[str])#

Exception thrown when a set of filters contravenes the API specification. Inherits from InvalidRequest.

exception analytix.errors.InvalidFilterValue(key: str, value: str)#

Exception thrown when an invalid value is provided for a filter. Inherits from InvalidRequest.

exception analytix.errors.UnsupportedFilterValue(key: str, value: str)#

Exception thrown when a valid value is provided for a filter, but cannot be used for the report type that has been selected. Inherits from InvalidRequest.

exception analytix.errors.InvalidAmountOfResults(actual: int, maximum: int)#

Exception thrown when the provided maximum number of results is not valid. Inherits from InvalidRequest.