PUT /comparison/{id}?type=finish

Ends an A/B test and declares a winner. Sets status to COMPLETED and stamps ended_at server‑side.

📘

Authorization

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

🚧

?type=finish is required

Missing or wrong type returns 400 "Type not specified".

⚠️

Winner not validated against the test's variants

The server checks winner_video_id belongs to the user, not specifically to the comparison's variants. Send only a video_id that is actually attached to the test, otherwise the winner stamp will reference a video outside the experiment.

HTTP Method & Path

PUT /comparison/{id}?type=finish

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

Path Parameters

Query Parameters

Request Body

Content-Type: application/json

{ "winner_video_id": "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d7" }

Response

Success Response (200)

{
  "id": "636f6d70-e29b-41d4-a716-446655440000",
  "name": "Thumb test — Q1",
  "status": "COMPLETED",
  "winner_video_id": "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d7",
  "ended_at": "2025-01-22T10:00:00.000Z",
  "videos": [ /* same shape as Get A/B Tests Properties */ ],
  "pullzone": "myzone"
}

Side effects

• The S3 config for the comparison is rewritten with status: "COMPLETED", the full list of video_external_ids and winner_video_id set to the winner's external id (not the internal UUID). The player uses this to route traffic to the winning variant going forward.
• An audit log is queued (category: comparison, activity: winner).

Error Responses

• 400 — body fails the AJV schema (missing winner_video_id, wrong UUID pattern, or extra properties). Also "Type not specified" if the query is missing.
• 404 — the winner video does not belong to the user.
• 401 — missing/invalid API Key.
• 500 — "Library not found", comparison not found, or internal error.

Example Usage

cURL

curl --request PUT \
  --url 'https://api-v2.pandavideo.com.br/comparison/636f6d70-e29b-41d4-a716-446655440000?type=finish' \
  --header 'Authorization: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{ "winner_video_id": "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d7" }'

Recipes