latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Overview

Displays an overview for the Box Office

This endpoint will show statistics information on the user's Box Office

get/v1/overview

Response

Successfully returned statistics information

box_office_namestring

creditsnumber

Credit balance for the Box Office

event_occurrences_draftnumber

event_occurrences_publishednumber

event_series_draftnumber

event_series_publishednumber

next_event_innumber nullable

Time until the next scheduled event, measured in days

orders_receivednumber

Orders received in the reporting period

periodstring

revenuenumber

total_issued_ticketsnumber

waitlist_signupsnumber

Waitlist sign-ups received in the reporting period

Example response

{
  "box_office_name": "My Box Office",
  "climate_impact": {
    "contribution": 1200,
    "estimated_footprint": 45000
  },
  "credits": 250,
  "currency": {
    "base_multiplier": 100,
    "code": "gbp",
    "symbol": "£"
  },
  "event_occurrences_draft": 4,
  "event_occurrences_published": 20,
  "event_series_draft": 1,
  "event_series_published": 5,
  "next_event_in": 7,
  "orders_received": 18,
  "period": "four weeks",
  "revenue": 134000,
  "total_issued_tickets": 40,
  "waitlist_signups": 3
}