API ReferenceActivities

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.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Query parameters

datedateOptional

Anchor date (ISO 8601) for the summary_type window.

end_timedatetimeOptional

Window end (ISO 8601).

feature_typestringOptional

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

pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
sort_byenumOptional

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.

Allowed values:
start_timedatetimeOptional

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

summary_typestringOptional

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

timezone_offsetdoubleOptional

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

Request

This endpoint expects an object.
filtersmap from strings to anyOptional
Filter parameters keyed by field name.

Response

countinteger
resultslist of objects
nextstring or nullformat: "uri"
previousstring or nullformat: "uri"
total_countinteger
current_filtersobject

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_dataobject