Server Information

class GroupByEnum

Bases: str, Enum

user = 'user'

day = 'day'

hour = 'hour'

country = 'country'

subdivision = 'subdivision'

__init__(*args, **kwds)

class DeleteBeforeDateBody

Bases: RestModelBase

Fields

Field	Type	Required	Default
before	datetime | None	No	None

Validators

Validator	Mode	Fields
parse_dates	before	before

before: datetime | None

classmethod parse_dates(v)

class AccessLogQueryFilters

Bases: QueryProjModelBase

Fields

Field	Type	Required	Default
after	datetime | None	No	None
before	datetime | None	No	None
cursor	int | None	No	None
exclude	list[str] | None	No	None
include	list[str] | None	No	None
limit	int | None	No	None
method	list[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None)]] | None	No	None
module	list[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None)]] | None	No	None
user	list[int | str] | None	No	None

Validators

Validator	Mode	Fields
parse_dates	before	before, after
validate_lists	before	limit, cursor

module: list[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None)]] | None

method: list[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None)]] | None

user: list[int | str] | None

before: datetime | None

after: datetime | None

classmethod parse_dates(v)

classmethod validate_lists(v)

limit

cursor

include

exclude

class AccessLogEntry

Bases: BaseModel

Fields

Field	Type	Required	Default
city	str | None	Yes
country_code	str | None	Yes
full_uri	str | None	Yes
id	int	Yes
ip_address	IPvAnyAddress | None	Yes
ip_lat	float | None	Yes
ip_long	float | None	Yes
method	str	Yes
module	str | None	Yes
request_bytes	float | None	Yes
request_duration	float | None	Yes
response_bytes	float | None	Yes
subdivision	str | None	Yes
timestamp	datetime	Yes
user	str | None	Yes
user_agent	str | None	Yes

id: int

timestamp: datetime

method: str

module: str | None

full_uri: str | None

request_duration: float | None

request_bytes: float | None

response_bytes: float | None

user: str | None

ip_address: IPvAnyAddress | None

user_agent: str | None

country_code: str | None

subdivision: str | None

city: str | None

ip_lat: float | None

ip_long: float | None

class AccessLogQueryIterator

Bases: QueryIteratorBase[AccessLogEntry]

Iterator for access log queries

This iterator transparently handles batching and pagination over the results of an access log query

__init__(client, query_filters)

Construct an iterator

Parameters:

• client – QCPortal client object used to contact/retrieve data from the server

• query_filters (AccessLogQueryFilters) – The actual query information to send to the server

reset()

Starts retrieval of results from the beginning again

class AccessLogSummaryFilters

Bases: RestModelBase

Fields

Field	Type	Required	Default
after	datetime | None	No	None
before	datetime | None	No	None
group_by	GroupByEnum	No	<GroupByEnum.day: 'day'>

Validators

Validator	Mode	Fields
parse_dates	before	before, after
validate_lists	before	before, after, group_by

group_by: GroupByEnum

before: datetime | None

after: datetime | None

classmethod validate_lists(v)

classmethod parse_dates(v)

class AccessLogSummaryEntry

Bases: BaseModel

Fields

Field	Type	Required	Default
count	int	Yes
method	str	Yes
module	str | None	Yes
request_duration_info	list[float]	Yes
response_bytes_info	list[float]	Yes

module: str | None

method: str

count: int

request_duration_info: list[float]

response_bytes_info: list[float]

class AccessLogSummary

Bases: BaseModel

Fields

Field	Type	Required	Default
entries	dict[str, list[AccessLogSummaryEntry]]	Yes

entries: dict[str, list[AccessLogSummaryEntry]]

class ErrorLogQueryFilters

Bases: QueryModelBase

Fields

Field	Type	Required	Default
after	datetime | None	No	None
before	datetime | None	No	None
cursor	int | None	No	None
error_id	list[int] | None	No	None
limit	int | None	No	None
user	list[int | str] | None	No	None

Validators

Validator	Mode	Fields
parse_dates	before	before, after
validate_lists	before	limit, cursor

error_id: list[int] | None

user: list[int | str] | None

before: datetime | None

after: datetime | None

classmethod parse_dates(v)

classmethod validate_lists(v)

limit

cursor

class ErrorLogEntry

Bases: BaseModel

Fields

Field	Type	Required	Default
error_date	datetime	Yes
error_text	str | None	Yes
id	int	Yes
qcfractal_version	str	Yes
request_body	str | None	Yes
request_headers	str | None	Yes
request_path	str | None	Yes
user	str | None	Yes

id: int

error_date: datetime

qcfractal_version: str

error_text: str | None

user: str | None

request_path: str | None

request_headers: str | None

request_body: str | None

class ErrorLogQueryIterator

Bases: QueryIteratorBase[ErrorLogEntry]

Iterator for error log queries

This iterator transparently handles batching and pagination over the results of an error log query

__init__(client, query_filters)

Construct an iterator

Parameters:

• client – QCPortal client object used to contact/retrieve data from the server

• query_filters (ErrorLogQueryFilters) – The actual query information to send to the server

reset()

Starts retrieval of results from the beginning again

class ServerStatsEntry

Bases: BaseModel

Fields

Field	Type	Required	Default
cpu_hours	float	Yes
database_size	int	Yes
date	date	Yes
record_count	int	Yes
record_count_details	dict[str, dict[RecordStatusEnum, int]]	Yes
timestamp	datetime	Yes

date: date

record_count: int

cpu_hours: float

record_count_details: dict[str, dict[RecordStatusEnum, int]]

database_size: int

timestamp: datetime