Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
playgrounds

Api Playgrounds Rows List Filtered

Default POST handler with automatic organization injection.

For CREATE operations:

  • Superadmins can specify organization_id in request body (API key only)
  • Regular users always use their own organization

Override this method for:

  • POST-for-filtering pattern (delegate to self.get())
  • Custom pre-create validation

Note: inject_target_organization is a DEPRECATED request.data-mutating shim kept for backward-compat during the DEV-9410 migration. The blessed path stamps org via get_create_save_kwargs → perform_create → a read_only serializer field. The shim (and these overrides' reliance on it) is removed in C18 (DEV-9430) once every view's org field is read_only.

post/api/playgrounds/{playground_id}/rows/list/

Path parameters

playground_idstring required

Query parameters

pageinteger

Page number for grouped Playground rows.

page_sizeinteger

Page size for grouped Playground rows.

sort_bystring

Sort grouped rows. Defaults to comparison_key. Supports row fields and cell sorting via cells__<experiment_id>.

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

filtersobject

Filter parameters keyed by metric name.

Response

countinteger required
total_countinteger required
nextstring nullable
previousstring nullable
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_dataobject