PUT /comparison/{id}?type=start

Starts an A/B test: moves the comparison from DRAFT to IN_PROGRESS and stamps started_at server‑side. Traffic begins being split across the attached variants and the player reads the updated S3 config.

📘

Authorization

Requires a valid API Key in the Authorization header. Send the key directly — no Bearer prefix.

🚧

?type=start is required

The gateway dispatches PUT /comparison/{id} by the query parameter type. Calling without ?type=start returns 400 "Type not specified".

HTTP Method & Path

PUT /comparison/{id}?type=start

Base URL: https://api-v2.pandavideo.com.br

Path Parameters

Query Parameters

Request Body

None. Send an empty body — the dashboard does the same. The handler does not parse the body on type=start.

Response

Success Response (200)

Returns the comparison with the new state, including its full videos[] and the user's pullzone.

{
  "id": "636f6d70-e29b-41d4-a716-446655440000",
  "name": "Thumb test — Q1",
  "status": "IN_PROGRESS",
  "started_at": "2025-01-15T10:00:00.000Z",
  "ended_at": null,
  "winner_video_id": null,
  "videos": [ /* same shape as Get A/B Tests Properties */ ],
  "pullzone": "myzone"
}

Side effects

• The S3 config for the comparison is rewritten with status: "IN_PROGRESS" and the list of video_external_ids — this is the file the player loads when picking a variant.
• An audit log is queued (category: comparison, activity: start).

Error Responses

• 400 — "Type not specified" when ?type=start is missing.
• 401 — missing/invalid API Key.
• 500 — "Library not found", comparison not found, or any internal error.

Example Usage

cURL

curl --request PUT \
  --url 'https://api-v2.pandavideo.com.br/comparison/636f6d70-e29b-41d4-a716-446655440000?type=start' \
  --header 'Authorization: <your-api-key>'

Recipes