v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB

activities

Api Activities Object Interactions Filtered

List object-interaction aggregates with complex filtering via POST body (POST-for-filtering — NOT a create). Scalar params stay in the query string exactly as on GET; the response is identical to the equivalent GET.

post/api/activities/object-interactions/

Query parameters

datestring date

Anchor date (ISO 8601) for the summary_type window.

end_timestring date-time

Window end (ISO 8601).

feature_typestring

Restrict to one resource kind (e.g. datasets, prompts). Omitted returns a mixed cross-feature list. Unknown values return 400.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

sort_by'-interaction_count' | '-last_interaction_at'

Sort key, '-'-prefixed for descending. Default is recency (-last_interaction_at); -interaction_count serves a most-visited view. Unknown values fall back to the default.

start_timestring date-time

Window start (ISO 8601). Overrides the summary_type/date window.

summary_typestring

Named window preset resolved relative to date (default: all).

timezone_offsetnumber double

Hours of UTC-minus-local offset used to resolve day boundaries.

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

filtersobject

Filter parameters keyed by field name.

Response

countinteger required

nextstring uri nullable

previousstring uri nullable

total_countinteger

current_filtersFilterParamDictPydantic

Pydantic model for FilterParamDict. A dictionary that maps metric names to their filter parameters.

Each key is a metric name (str), and each value can be:

A single MetricFilterParamPydantic (one condition)
A List[MetricFilterParamPydantic] (multiple conditions for same metric)
A FilterBundlePydantic (nested filter bundle with connector)

Note: Uses extra="allow" for dynamic metric name fields. The pydantic_extra annotation tells Pydantic what types to expect for extra fields, and generates typed additionalProperties in JSON Schema.

filters_dataPaginatedObjectInteractionListFiltersData