Events

GET /reports/events

Resource information

Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
nonProfitId optional Comma separated numerical IDs of the desired non-profit(s). 1,2,3
minDate optional Returns events created after the given date. Date should be formatted as YYYY-MM-DD. 2019-01-01
maxDate optional Returns events created before the given date. Date should be formatted as YYYY-MM-DD. 2019-12-31
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1
order optional Causes the collection of events to be ordered in ascending or descending order (can be asc or desc) desc
orderBy optional Causes the collection of events to be ordered by the selected column (can be start_at or end_at). If not provided, results will be ordered by event id start_at

Response


{
  "currentPage": 1,
  "nextPage": 2,
  "previousPage": null,
  "totalPages": 19, 
  "itemCount": 383,
  "items": [
    {
      "eventId": 17,
      "title": "Test",
      "drawDate": "2012-10-25T03:00:00.000000Z",
      "startDate": "2012-10-24T22:00:00.000000Z",
      "endDate": "2012-10-25T03:00:00.000000Z",
      "nonProfitId": 1,
      "nonProfitName": "Non-profit"
    },
    ...
  ]
}

GET /reports/events/details

Resource information

Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
eventId optional Comma separated numerical IDs of the desired event(s). 1,2,3
nonProfitId optional Comma separated numerical IDs of the desired non-profit(s). 1,2,3
minDate optional Returns events created after the given date. Date should be formatted as YYYY-MM-DD. 2019-01-01
maxDate optional Returns events created before the given date. Date should be formatted as YYYY-MM-DD. 2019-12-31
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1
order optional Causes the collection of events to be ordered in ascending or descending order (can be asc or desc) desc
orderBy optional Causes the collection of events to be ordered by the selected column (can be start_at or end_at). If not provided, results will be ordered by event id start_at

Response


{
  "currentPage": 1,
  "nextPage": 2,
  "previousPage": null,
  "totalPages": 76,  
  "itemCount": 5,
  "items": [
    {
      "eventId": 449,
      "title": "Test 2019 03 15",
      "drawDate": "2019-03-19T03:45:00.000000Z",
      "startDate": "2019-03-18T04:00:00.000000Z",
      "endDate": "2019-03-19T03:45:00.000000Z",
      "nonProfitId": 7,
      "nonProfitName": "Bump 50:50",
      "jackpot": {
        "startingJackpot": 0,
        "sales": 601.26,
        "contributions": 0,
        "expenses": 67.27,
        "jackpot": 601,
        "prize": 300
      },
      "sales": {
        "gross": 757,
        "refunded": 95,
        "expenses": 60.74,
        "net": 601.26
      },
      "expenses": {
        "total": 67.27,
        "flat": 52.99,
        "creditCard": 0,
        "debitCard": 0,
        "venueTotal": 0,
        "venueJackpot": 0,
        "creditCardTransactions": 1.02,
        "creditCardPercent": 13.26,
				"debitCardTransactions": 12.34,
				"debitCardPercent": 56.78
      },
      "transactions": {
        "gross": 54,
        "refunded": 11,
        "net": 43,
        "cash": 9,
        "credit": 34,
        "debit": 34
      },
      "tickets": {
        "sets": 54,
        "numbers": 579
      },
      "winner": {
        "ticketNumber": 3712156005,
        "ticketQuantity": 10,
        "ticketCost": 10,
        "firstName": null,
        "lastName": null,
        "prize": 300,
        "prizeClaimed": 0,
        "pickedTime": "2019-03-19T03:45:00.000000Z"
      },
			"secondaryDraws": [
				{
					"ticketNumber": 419707121,
					"ticketQuantity": 10,
					"ticketCost": 10,
					"firstName": "QA",
					"lastName": "Tester",
					"title": "Weekly Prize",
					"prize": "2.00",
					"prizeClaimed": 0,
					"pickedTime": "2024-01-17 14:40:30"
				}
        ...
			]
    }
    ...
  ]
}