API ReferencePlaygrounds

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.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

playground_idstringRequired

Query parameters

pageintegerOptional
Page number for grouped Playground rows.
page_sizeintegerOptional
Page size for grouped Playground rows.
sort_bystringOptional

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

Request

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

Response

countinteger
total_countinteger
resultslist of objects
nextstring or null
previousstring or null
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_datamap from strings to any