Actualizar experimento

Actualice parcialmente un experimento por ID. Solo se actualizan los campos proporcionados. Si se proporcionan asignaciones, se reemplaza el conjunto completo de asignaciones.

PATCH https://{tenantDomain}/api/v2/experimentation/experiments/{id}

Actualiza un experimento.

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/experimentation/experiments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allocations": [
    {
      "is_control": true,
      "variation_id": "<string>",
      "is_fallback": true,
      "priority": 2,
      "segment_id": "<string>",
      "weight": 50
    }
  ],
  "description": "<string>",
  "name": "<string>"
}
'

200

{
  "allocations": [
    {
      "is_control": true,
      "is_fallback": true,
      "priority": 123,
      "segment_id": "<string>",
      "variation_id": "<string>",
      "weight": 123
    }
  ],
  "assignment_config": {
    "subject": "device"
  },
  "authentication_flow": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "feature_flag_id": "<string>",
  "id": "<string>",
  "is_valid": true,
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "ended_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

El ID del experimento que se va a actualizar.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

Actualización parcial de un experimento. Solo se actualizan los campos proporcionados. Si se proporcionan asignaciones, se reemplaza todo el conjunto de asignaciones.

allocations · object[]

Reemplaza todas las asignaciones de tráfico. No se puede modificar mientras el experimento esté activo.

Minimum array length: 1

Show child attributes

assignment_config · object

Configuración de cómo se asigna a los usuarios a las variaciones

Show child attributes

description · string | null

Una descripción del experimento

Required string length: 3 - 1024

Pattern: ^(?!.*\x00)\S(.*\S)?$

name · string

Un nombre descriptivo para el experimento

Required string length: 3 - 255

Pattern: ^(?!.*\x00)\S(.*\S)?$

Respuesta

200

application/json

Experimento actualizado correctamente.

allocation_strategy · enum<string> · requerido

Opciones disponibles: percentage, segment

allocations · object[] · requerido

Show child attributes

assignment_config · object · requerido

Show child attributes

authentication_flow · string · requerido

created_at · string<date-time> · requerido

feature_flag_id · string · requerido

id · string · requerido

Pattern: ^exp_[A-HJ-NP-Za-km-z1-9]+$

is_valid · boolean · requerido

name · string · requerido

status · enum<string> · requerido

Filtrar por estado. Coincidencia exacta.

Opciones disponibles: draft, active, paused, completed, archived

updated_at · string<date-time> · requerido

description · string

ended_at · string<date-time>

started_at · string<date-time>