JSON API Details

Game HTTP API — JSON Payload Details

API to start a game and retrieve {key}-json-game-data-file.json

QuestionSet Example

{
  "code": "Blue-Dancing-Horse",
  "startTime": null,
  "questions": [
    {
      "questionIndex": 1,
      "illustrationUrl": "https://url/media-hash",
      "questionText": "What is the wingspan of a Norwegian Boeing 747 in {$1}",
      "isoUnit": "m",
      "defaultMax": null,
      "defaultMin": -100,
      "correctValue": null,
      "questionTimeLimitSec": 60
    },
    {
      "questionIndex": 2,
      "illustrationUrl": "https://url/media-hash",
      "questionText": "Number of McDonald's Double Cheese meals served each day in {$1}",
      "isoUnit": "units",
      "defaultMax": null,
      "defaultMin": -100,
      "correctValue": null,
      "questionTimeLimitSec": 60
    },
    {
      "questionIndex": 3,
      "illustrationUrl": "https://url/media-hash",
      "questionText": "Height of Seip Mountain in {$1}",
      "isoUnit": "m",
      "defaultMax": null,
      "defaultMin": -100,
      "correctValue": null,
      "questionTimeLimitSec": 60
    }
  ]
}

Answer Example

{
  "questionId": 1,
  "playerId": "p-2",
  "userMin": 55,
  "userMax": 72,
  "submittedAt": 1700000042000
}

ScoreResult Example

{
  "rankings": [
    { "rank": 1, "playerId": "p-3", "name": "Carol" },
    { "rank": 2, "playerId": "p-2", "name": "Bob" }
  ],
  "fastestAvgResponseMs": { "playerId": "p-3", "name": "Carol", "avgMs": 8200 },
  "slowestAvgResponseMs": { "playerId": "p-2", "name": "Bob", "avgMs": 14500 }
}