Game Reports**

Get Game Outcomes Reports

GET /game/history

Query Parameters

Name
Type
Description

start

timestamp

start time (>=) in ISO 8601 format

end

timestamp

end time (<) in ISO 8601 format

page

number (optional)

the page number to retrieve (starts with 0)

page_size

number (optional)

results per page, default 1000

user_id

string (optional)

filter by user_id

Response

{
  "status": "success",
  "items": [
    {
      "id": string,
      "user_id": string,
      "prize": {
          "entry_truck": number, // number is always 1
          "entry_flight": number, // number is always 1
          "prize_money_transfer": number,
          "prize_cash_back": number, 
          "prize_streaming": number,
          "prize_imt": number,
          "prize_gift_card": number,
          "prize_phone_accessory": number,
          "prize_merchandise": number,
          "tickets": number,
          "cash_usd": number // Only one of tickets or cash_usd will have a value
      },
      "timestamp": string, // ISO 8601 format
      "game_status": string, //possible values: "Cash", "Extra-prize", "Ticket-only"
      "result_effective_date": string // ISO 8601 format
    },
    ...
  ],
  "total_count": number, // total result count
  "page": number, // starts with 0
  "page_size": number, // results per page
  "total_pages": number // total available pages
}

Get Ticket Balance History Reports

GET /tickets/history

Body

Name
Type
Description

start

timestamp

start time (>=)

end

timestamp

end time (<)

page

number (optional)

the page number to retrieve (starts at 0)

page_size

number (optional)

results per page, default 1000

user_id

string (optional)

filter by user_id

Response

{
  "status": "success",
  "transactions": [
    {
      "user_id": string,
      "transaction_id": string,
      "idempotency_key": string,
      "outcome_id": string, // if this is from a game, this field will be set
      "amount": number, // can be negative for debit
      "description": string,
      "date_created": string,  // ISO 8601 format
      "result_effective_date": string // ISO 8601 format
    },
    ...
  ],
  "total_count": number, // total result count
  "page": number, // starts with 0
  "page_size": number, // results per page
  "total_pages": number // total available pages
}

Get Entry History Reports

GET /entrties/history

Body

Name
Type
Description

start

timestamp

start time (>=)

end

timestamp

end time (<)

page

number (optional)

the page number to retrieve (starts at 0)

page_size

number (optional)

results per page, default 1000

user_id

string (optional)

filter by user_id

entry_type

string (optional)

enum('truck', 'flight'), return all types if null

Response

{
  "status": "success",
  "transactions": [
    {
      "user_id": string,
      "transaction_id": string,
      "idempotency_key": string,
      "outcome_id": string, // if this is from a game, this field will be set
      "entry_type": string, // possible values: "truck", "flight"
      "amount": number,
      "description": string,
      "date_created": string,  // ISO 8601 format
      "result_effective_date": string // ISO 8601 format
    },
    ...
  ],
  "total_count": number, // total result count
  "page": number, // starts with 0
  "page_size": number, // results per page
  "total_pages": number // total available pages
}

Last updated

Was this helpful?