콘테스트

콘테스트 정보를 관리하고 조회하세요.

콘테스트 목록

GET/api/v1/contests

Public or Private API Key

API 키와 연결된 팀에 속한 모든 콘테스트 목록을 반환합니다.

요청

파라미터 필요 없음.

bash

curl -X GET https://blitzrocket.com/api/v1/contests \
  -H "x-api-key: your_api_key_here"

javascript

const response = await fetch("https://blitzrocket.com/api/v1/contests", {
  headers: {
    "x-api-key": "your_api_key_here",
  },
});

const { success, data } = await response.json();
console.log(data);
// => [{ id: "abc123", title: "Summer Giveaway", ... }, ...]

python

import requests

response = requests.get(
    "https://blitzrocket.com/api/v1/contests",
    headers={"x-api-key": "your_api_key_here"}
)

data = response.json()
print(data["data"])
# => [{"id": "abc123", "title": "Summer Giveaway", ...}, ...]

응답

json

{
  "success": true,
  "data": [
    {
      "id": "clx1abc123def456",
      "title": "Summer Giveaway 2025",
      "description": "이번 여름 멋진 상품을 받으세요!",
      "status": "active",
      "startDate": "2025-06-01T00:00:00.000Z",
      "endDate": "2025-08-31T23:59:59.000Z",
      "isEvergreen": false,
      "mode": "giveaway",
      "slug": "summer-giveaway-2025",
      "entriesCount": 1523
    },
    {
      "id": "clx2def456ghi789",
      "title": "제품 출시 콘테스트",
      "description": null,
      "status": "draft",
      "startDate": null,
      "endDate": null,
      "isEvergreen": true,
      "mode": "leaderboard",
      "slug": "product-launch",
      "entriesCount": 0
    }
  ]
}

응답 필드

idstring

콘테스트 고유 식별자

titlestring

콘테스트 제목

descriptionstring | null

콘테스트 설명 텍스트

statusstring

현재 상태: draft, active, ended, 또는 paused

startDatestring | null

ISO 8601 시작 날짜, 설정되지 않은 경우 null

endDatestring | null

ISO 8601 종료 날짜, 설정되지 않은 경우 null

isEvergreenboolean

콘테스트가 무기한 진행되는지 여부

modestring

콘테스트 모드: giveaway, leaderboard, 또는 waitlist

slugstring

URL 친화적인 고유 식별자

entriesCountnumber

콘테스트 참가 총 수

콘테스트 조회

GET/api/v1/contests/:contestId

Public or Private API Key

특정 콘테스트에 대한 상세 정보를 조회합니다.

경로 파라미터

contestIdstring required

고유 콘테스트 식별자

요청

bash

curl -X GET https://blitzrocket.com/api/v1/contests/clx1abc123def456 \
  -H "x-api-key: your_api_key_here"

javascript

const contestId = "clx1abc123def456";
const response = await fetch(
  `https://blitzrocket.com/api/v1/contests/${contestId}`,
  {
    headers: { "x-api-key": "your_api_key_here" },
  }
);

const { success, data } = await response.json();
console.log(data);

python

import requests

contest_id = "clx1abc123def456"
response = requests.get(
    f"https://blitzrocket.com/api/v1/contests/{contest_id}",
    headers={"x-api-key": "your_api_key_here"}
)

data = response.json()
print(data["data"])

응답

json

{
  "success": true,
  "data": {
    "id": "clx1abc123def456",
    "title": "Summer Giveaway 2025",
    "description": "이번 여름 멋진 상품을 받으세요!",
    "status": "active",
    "startDate": "2025-06-01T00:00:00.000Z",
    "endDate": "2025-08-31T23:59:59.000Z",
    "isEvergreen": false,
    "mode": "giveaway",
    "slug": "summer-giveaway-2025",
    "entriesCount": 1523,
    "viewsCount": 12847
  }
}

오류 응답

상태	오류	설명
`400`	contestId 누락	contestId 경로 파라미터가 필요합니다
`401`	API 키 유효하지 않음	API 키가 없거나 유효하지 않습니다
`404`	콘테스트를 찾을 수 없음	주어진 ID에 해당하는 콘테스트가 없습니다