初めて使う場合は、先にQuagga API概要を読んでください。

概要

APIエンドポイント

https://quagga.studio/api/v1

以降に出てくるパスは、このエンドポイントに続けて指定します。 例: GET /programs/1/result/total は https://quagga.studio/api/v1/programs/1/result/total に送ります。

データ形式

JSON

アクセストークン

全てのAPIリクエストに、Authorizationリクエストヘッダでアクセストークンを付与してください。 アクセストークンは、プロフィールの「アクセストークン」に記載されています。

Authorization: Bearer QuAGGa2023APitoKeNSAMPle

上記はサンプルです。実際には、ご自身のアクセストークンを指定してください。

対象イベントの管理者のアカウントのアクセストークンのみ利用できます。 管理者ではない場合は 401 が返却されます。 アクセストークンは他の人に知られないように管理してください。

イベントID

特定のイベントの情報を取得する場合は、イベントIDが必要です。

イベントIDは回答/管理画面のURLから取得することができます。

例 （以下では、「1」がイベントIDになります）

https://quagga.studio/programs/1/quiz
https://quagga.studio/programs/1/admin

リクエスト例

イベントID 1 の暫定総合成績を取得する例です。

curl -H "Authorization: Bearer QuAGGa2023APitoKeNSAMPle" https://quagga.studio/api/v1/programs/1/result/total

ステータスコード

下記のコードを返却します。

エラーレスポンス

400 401 404 500 の場合、次の形式で原因が返却されます。

{
  "error": {
    "message": "認証できませんでした。"
  }
}

message には、エラーの内容が日本語で入ります。

利用制限

ユーザ毎に1分間に30リクエストまで受け付けます。 決められた制限を超える場合は、429 Too Many Requests が返却されます。

API

レスポンスに含まれる question answer member user result の各項目は、このページ末尾の「レスポンスの項目」にまとめています。

問題情報一覧

イベントに登録されている問題を、すべて取得します。

GET /programs/{event_id}/questions

Request

Response

{
  "questions": [
    {
      "id": "40255a8a-944d-461a-9e01-ec3585b1bbee",
      "period": 1,
      "description": "絵画を発表された順に並べて",
      "q_format": "bonus",
      "answer": "2,4,1,3",
      "point": 3,
      "time": 15,
      "choice_number": 4,
      "answer_number": 4,
      "choices": [],
      "is_enquete": false,
      "money": 250000,
      "payment_type_name": "split"
    }
  ]
}

問題詳細

1問の情報と、その問題への回答一覧を取得します。 回答は、回答タイムの早い順に並びます。

GET /programs/{event_id}/questions/{question_id}

Request

Response

{
  "question": {
    "id": "40255a8a-944d-461a-9e01-ec3585b1bbee",
    "period": 1,
    "description": "絵画を発表された順に並べて",
    "q_format": "bonus",
    "answer": "2,4,1,3",
    "point": 3,
    "time": 15,
    "choice_number": 4,
    "answer_number": 4,
    "choices": [],
    "is_enquete": false,
    "money": 250000,
    "payment_type_name": "split"
  },
  "answers": [
    {
      "id": 1,
      "answer": "1,2,3,4",
      "correct": false,
      "point": 4,
      "time": "5.63",
      "money": "0.0",
      "member": {
        "id": 1,
        "admin": false,
        "user": {
          "id": 1,
          "name": "クアッガ",
          "name_gana": "くあっが"
        }
      },
      "question_id": "40255a8a-944d-461a-9e01-ec3585b1bbee"
    }
  ]
}

直近に集計された問題情報

直前に集計した問題の情報と、その問題への回答一覧を取得します。 回答は、回答タイムの早い順に並びます。 まだ1問も集計していない場合は 404 が返却されます。

GET /programs/{event_id}/questions/last_aggregate

Request

Response

レスポンスの形式は「問題詳細」と同じです。

{
  "question": {
    "id": "40255a8a-944d-461a-9e01-ec3585b1bbee",
    "period": 1,
    "description": "絵画を発表された順に並べて",
    "q_format": "bonus",
    "answer": "2,4,1,3",
    "point": 3,
    "time": 15,
    "choice_number": 4,
    "answer_number": 4,
    "choices": [],
    "is_enquete": false,
    "money": 250000,
    "payment_type_name": "split"
  },
  "answers": [
    {
      "id": 1,
      "answer": "1,2,3,4",
      "correct": false,
      "point": 4,
      "time": "5.63",
      "money": "0.0",
      "member": {
        "id": 1,
        "admin": false,
        "user": {
          "id": 1,
          "name": "クアッガ",
          "name_gana": "くあっが"
        }
      },
      "question_id": "40255a8a-944d-461a-9e01-ec3585b1bbee"
    }
  ]
}

特定のピリオドのチャンピオン情報

指定したピリオドのチャンピオンを取得します。

GET /programs/{event_id}/periods/{period}/champion

Request

例: 直近に集計された問題のピリオドのチャンピオンを取得する

GET /programs/1/periods/last_aggregate/champion

Response

{
  "champion": {
    "id": 1,
    "admin": false,
    "user": {
      "id": 1,
      "name": "クアッガ",
      "name_gana": "くあっが"
    }
  }
}

特定のピリオドの成績

指定したピリオドの成績（ランキング）を取得します。 まだ1問も集計していない場合は 404 が返却されます。

GET /programs/{event_id}/result/period

Request

period はパスではなく、クエリパラメータで指定します。

例: ピリオド2の成績を取得する

GET /programs/1/result/period?period=2

Response

{
  "results": [
    {
      "rank": 1,
      "point": 123,
      "time": "404.3",
      "money": "123456.0",
      "member": {
        "id": 1,
        "admin": false,
        "user": {
          "id": 1,
          "name": "クアッガ",
          "name_gana": "くあっが"
        }
      }
    }
  ]
}

暫定総合成績

リクエスト時点での総合成績（ランキング）を取得します。

GET /programs/{event_id}/result/total

Request

Response

レスポンスの形式は「特定のピリオドの成績」と同じです。

{
  "results": [
    {
      "rank": 1,
      "point": 123,
      "time": "404.3",
      "money": "123456.0",
      "member": {
        "id": 1,
        "admin": false,
        "user": {
          "id": 1,
          "name": "クアッガ",
          "name_gana": "くあっが"
        }
      }
    }
  ]
}

レスポンスの項目

question

問題の情報です。

answer

参加者1人分の回答です。

time と money は、数値ではなく文字列（例: "5.63"）で返却されます。

result

参加者1人分の成績です。

time と money は、数値ではなく文字列（例: "404.3"）で返却されます。

member

イベントの参加者の情報です。

user

ユーザーの情報です。