Dokumentacja API

Dokumentacja API

Programowy dostęp do quizów i leadów Convertly.

Uwierzytelnianie

Wszystkie żądania API wymagają tokena Bearer w nagłówku Authorization. Klucze API generujesz w ustawieniach konta.

Authorization: Bearer cvt_live_YOUR_API_KEY

Zarządzaj kluczami API z sekcji API w panelu.

Dostęp wg planu

Pro
API tylko do odczytu

Endpointy GET — pobieraj dane quizów i leadów do CRM, Zapiera, Airtable lub narzędzi BI.

Business
Pełne API (odczyt + zapis)

Wszystkie endpointy GET plus POST/PUT — twórz quizy programowo, headless quiz submission.

Limity żądań

Żądania API są limitowane na użytkownika, we wszystkich kluczach API.

Limit1,000 żądań / godzinęNagłówek odpowiedziX-RateLimit-Remaining

Endpointy

GET
/api/v1/quizzes
Pro+

Lista wszystkich quizów (paginowana). Zawiera quizy zespołu.

curl -H "Authorization: Bearer cvt_live_YOUR_KEY" \
  "https://convertly.buzz/api/v1/quizzes?page=1&limit=20"
GET
/api/v1/quizzes/:id
Pro+

Pobierz quiz ze wszystkimi pytaniami, opcjami i zakresami wyników.

curl -H "Authorization: Bearer cvt_live_YOUR_KEY" \
  "https://convertly.buzz/api/v1/quizzes/QUIZ_ID"
GET
/api/v1/quizzes/:id/leads
Pro+

Lista leadów dla danego quizu (paginowana).

curl -H "Authorization: Bearer cvt_live_YOUR_KEY" \
  "https://convertly.buzz/api/v1/quizzes/QUIZ_ID/leads?page=1&limit=20"
GET
/api/v1/leads/:id
Pro+

Pobierz pojedynczy lead ze szczegółami zakresu wyniku.

curl -H "Authorization: Bearer cvt_live_YOUR_KEY" \
  "https://convertly.buzz/api/v1/leads/LEAD_ID"
POST
/api/v1/quizzes
Business

Utwórz nowy quiz (wersja robocza). Wymaga planu Business.

curl -X POST \
  -H "Authorization: Bearer cvt_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "My Quiz", "description": "Optional description", "language": "en"}' \
  "https://convertly.buzz/api/v1/quizzes"
PUT
/api/v1/quizzes/:id
Business

Zaktualizuj metadane quizu (tytuł, publikacja, webhook itp.). Wymaga planu Business.

curl -X PUT \
  -H "Authorization: Bearer cvt_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Updated Title", "published": true}' \
  "https://convertly.buzz/api/v1/quizzes/QUIZ_ID"
POST
/api/v1/quizzes/:id/submit
Business

Headless quiz submission — prześlij odpowiedzi, otrzymaj wynik. Wymaga planu Business.

curl -X POST \
  -H "Authorization: Bearer cvt_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "answers": [
      {"question_id": "q1", "option_id": "o2"},
      {"question_id": "q2", "option_id": "o5"}
    ]
  }' \
  "https://convertly.buzz/api/v1/quizzes/QUIZ_ID/submit"

Paginacja

Endpointy listowe obsługują paginację z parametrami page i limit. Domyślnie: page=1, limit=20. Maks. limit: 100.

GET /api/v1/quizzes?page=2&limit=10

Odpowiedzi zawierają obiekt paginacji:

{
  "data": [...],
  "pagination": {
    "page": 2,
    "limit": 10,
    "total": 45,
    "total_pages": 5
  }
}
Convertly - Create Lead Generation Quizzes