Skip to content

Category data

CategoryDataClient

Synchronous category data operations for the key-bound category.

schema()

Return the active schema used to validate category observations.

list(*, from_=None, to=None, limit=100, offset=0)

List category observations in an optional time range.

from_ and to are inclusive API filters when supplied. Omit either one to leave that end of the range unbounded.

latest()

Return the latest category observation.

create(*, observed_at, data, external_id=UNSET)

Create a category observation.

Parameters:

Name Type Description Default
observed_at datetime

Time at which the source observed data.

required
data dict[str, Any]

Values conforming to :meth:schema.

required
external_id str | None | Any

Provider-side identity used for idempotency. Omit it when the source has no stable identifier; pass None to explicitly send a null identifier.

UNSET

Returns:

Type Description
CategoryDataRecordPublic

The created observation.

Raises:

Type Description
OblidogValidationError

If the observation does not match schema.

CategoryDataRecordPublic

Attributes:

Name Type Description
created_at datetime
data CategoryDataRecordPublicData
external_id None | str
id UUID
observed_at datetime
schema_version int
source None | str

CategoryDataRecordsPublic

Attributes:

Name Type Description
count int
data list[CategoryDataRecordPublic]

CategoryDataSchemaPublic

Attributes:

Name Type Description
created_at datetime
is_active bool
schema CategoryDataSchemaPublicSchema
version int