Skip to main content
GET
/
event-statistics
Retrieve Event Statistics
curl --request GET \
  --url https://api.nuwebgroup.com/v1/event-statistics \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "global": {
      "salesVolume": "2.20",
      "salesUrl": "https://admin.ticketing-platform.com/v1/report?id=sales&filter%5Bevents%5D%5B0%5D=12&headers%5B0%5D=total_gross_currency_1&headers%5B1%5D=total_discounts_currency_1&headers%5B2%5D=total_online_refunds_currency_1&headers%5B3%5D=total_offline_refunds_currency_1&headers%5B4%5D=total_fees_currency_1&headers%5B5%5D=total_tax_currency_1&headers%5B6%5D=total_net_currency_1&headers%5B7%5D=total_gross_currency_2&headers%5B8%5D=total_discounts_currency_2&headers%5B9%5D=total_online_refunds_currency_2&headers%5B10%5D=total_offline_refunds_currency_2&headers%5B11%5D=total_fees_currency_2&headers%5B12%5D=total_tax_currency_2&headers%5B13%5D=total_net_currency_2&headers%5B14%5D=total_gross_currency_5&headers%5B15%5D=total_discounts_currency_5&headers%5B16%5D=total_online_refunds_currency_5&headers%5B17%5D=total_offline_refunds_currency_5&headers%5B18%5D=total_fees_currency_5&headers%5B19%5D=total_tax_currency_5&headers%5B20%5D=total_net_currency_5&title=Event%20sales%20report&template=1&grouping=item_name",
      "attendeesCount": 2,
      "attendeesUrl": "https://admin.newtickets.test/order-items?filter%5Bevents%5D%5B0%5D=12",
      "orderQuantity": 1,
      "ordersUrl": "https://admin.newtickets.test/orders?filter%5Bevents%5D%5B0%5D=12",
      "capacity": {
        "remaining": 998,
        "total": 1000,
        "used": 2,
        "usage": "0.20"
      }
    },
    "items": {
      "tickets": {
        "salesVolume": "2.20",
        "salesUrl": "https://admin.ticketing-platform.com/v1/report?id=sales&filter%5Bitem_types%5D%5B0%5D=1&filter%5Bevents%5D%5B0%5D=12&headers%5B0%5D=item_name&headers%5B1%5D=total_issued_inc_cancellations&headers%5B2%5D=total_issued_ex_cancellations&headers%5B3%5D=total_gross_currency_1&headers%5B4%5D=total_discounts_currency_1&headers%5B5%5D=total_net_currency_1&headers%5B6%5D=total_gross_currency_2&headers%5B7%5D=total_discounts_currency_2&headers%5B8%5D=total_net_currency_2&headers%5B9%5D=total_gross_currency_5&headers%5B10%5D=total_discounts_currency_5&headers%5B11%5D=total_net_currency_5&title=Ticket%20sales%20report&template=1&grouping=item_name",
        "soldQuantity": 2,
        "soldUrl": "https://admin.ticketing-platform.com/v1/report?id=attendance&filter%5Bitem_types%5D%5B0%5D=1&filter%5Bstatuses%5D%5B0%5D=valid&filter%5Bevents%5D%5B0%5D=12&headers%5B0%5D=barcode&headers%5B3%5D=purchaser_email&headers%5B4%5D=item_holder_email&headers%5B5%5D=item_name&headers%5B6%5D=item_status&headers%5B7%5D=order_reference&headers%5B8%5D=reservation_completed_at&headers%5B9%5D=event_name&headers%5B10%5D=first_scan_in_date&title=Ticket%20attendance%20report&order=-reservation_completed_at&template=1",
        "top4": [
          {
            "id": 1,
            "name": "Standard Laughing Ticket",
            "sales": "2.20",
            "quantity": 2,
            "salesUrl": "https://admin.ticketing-platform.com/v1/report?id=sales&filter%5Bitem_types%5D%5B0%5D=1&filter%5Bevents%5D%5B0%5D=12&filter%5Bitem_name%5D=Standard%2BLaughing%2BTicket&headers%5B0%5D=total_gross_currency_1&headers%5B1%5D=total_discounts_currency_1&headers%5B2%5D=total_online_refunds_currency_1&headers%5B3%5D=total_offline_refunds_currency_1&headers%5B4%5D=total_fees_currency_1&headers%5B5%5D=total_tax_currency_1&headers%5B6%5D=total_net_currency_1&headers%5B7%5D=total_gross_currency_2&headers%5B8%5D=total_discounts_currency_2&headers%5B9%5D=total_online_refunds_currency_2&headers%5B10%5D=total_offline_refunds_currency_2&headers%5B11%5D=total_fees_currency_2&headers%5B12%5D=total_tax_currency_2&headers%5B13%5D=total_net_currency_2&headers%5B14%5D=total_gross_currency_5&headers%5B15%5D=total_discounts_currency_5&headers%5B16%5D=total_online_refunds_currency_5&headers%5B17%5D=total_offline_refunds_currency_5&headers%5B18%5D=total_fees_currency_5&headers%5B19%5D=total_tax_currency_5&headers%5B20%5D=total_net_currency_5&title=Item%20sales%20report&template=1&grouping=sale_item_id",
            "rank": 1
          }
        ],
        "totalCount": 2,
        "additionalCount": 0,
        "capacity": {
          "remaining": 998,
          "total": 1000,
          "used": 2,
          "usage": "0.20"
        }
      }
    },
    "timeslots": {
      "salesVolume": "2.20",
      "salesUrl": "https://admin.ticketing-platform.com/v1/report?id=sales&filter%5Bhas_timeslot%5D=1&filter%5Bevents%5D%5B0%5D=12&headers%5B0%5D=total_gross_currency_1&headers%5B1%5D=total_discounts_currency_1&headers%5B2%5D=total_online_refunds_currency_1&headers%5B3%5D=total_offline_refunds_currency_1&headers%5B4%5D=total_fees_currency_1&headers%5B5%5D=total_tax_currency_1&headers%5B6%5D=total_net_currency_1&headers%5B7%5D=total_gross_currency_2&headers%5B8%5D=total_discounts_currency_2&headers%5B9%5D=total_online_refunds_currency_2&headers%5B10%5D=total_offline_refunds_currency_2&headers%5B11%5D=total_fees_currency_2&headers%5B12%5D=total_tax_currency_2&headers%5B13%5D=total_net_currency_2&headers%5B14%5D=total_gross_currency_5&headers%5B15%5D=total_discounts_currency_5&headers%5B16%5D=total_online_refunds_currency_5&headers%5B17%5D=total_offline_refunds_currency_5&headers%5B18%5D=total_fees_currency_5&headers%5B19%5D=total_tax_currency_5&headers%5B20%5D=total_net_currency_5&title=Event%20sales%20report&template=1&grouping=sale_item_id",
      "soldQuantity": 2,
      "soldUrl": "https://admin.ticketing-platform.com/v1/report?id=attendance&filter%5Bstatuses%5D%5B0%5D=valid&filter%5Bhas_timeslot%5D=1&filter%5Bevents%5D%5B0%5D=12&headers%5B0%5D=barcode&headers%5B3%5D=purchaser_email&headers%5B4%5D=item_holder_email&headers%5B5%5D=item_name&headers%5B6%5D=item_status&headers%5B7%5D=order_reference&headers%5B8%5D=reservation_completed_at&headers%5B9%5D=event_name&headers%5B10%5D=first_scan_in_date&title=Item%20attendance%20report&order=-reservation_completed_at&template=1",
      "top4": [
        {
          "id": 4,
          "name": "Late Slot - 16th August 2023 from 20:00 PM to 21:00 PM",
          "sales": "1.10",
          "quantity": 1,
          "url": "https://admin.ticketing-platform.com/v1/report?id=attendance&filter%5Bstatuses%5D%5B0%5D=valid&filter%5Bhas_timeslot%5D=1&filter%5Bevents%5D%5B0%5D=12&filter%5Btimeslot_name%5D=Late%2BSlot%2B-%2B16th%2BAugust%2B2023%2Bfrom%2B20%253A00%2BPM%2Bto%2B21%253A00%2BPM&headers%5B0%5D=barcode&headers%5B3%5D=purchaser_email&headers%5B4%5D=item_holder_email&headers%5B5%5D=item_name&headers%5B6%5D=item_status&headers%5B7%5D=order_reference&headers%5B8%5D=reservation_completed_at&headers%5B9%5D=event_name&headers%5B10%5D=first_scan_in_date&title=Item%20attendance%20report&order=-reservation_completed_at&template=1",
          "rank": 1
        },
        {
          "id": 3,
          "name": "Early Slot - 16th August 2023 from 19:00 PM to 20:00 PM",
          "sales": "1.10",
          "quantity": 1,
          "url": "https://admin.ticketing-platform.com/v1/report?id=attendance&filter%5Bstatuses%5D%5B0%5D=valid&filter%5Bhas_timeslot%5D=1&filter%5Bevents%5D%5B0%5D=12&filter%5Btimeslot_name%5D=Early%2BSlot%2B-%2B16th%2BAugust%2B2023%2Bfrom%2B19%253A00%2BPM%2Bto%2B20%253A00%2BPM&headers%5B0%5D=barcode&headers%5B3%5D=purchaser_email&headers%5B4%5D=item_holder_email&headers%5B5%5D=item_name&headers%5B6%5D=item_status&headers%5B7%5D=order_reference&headers%5B8%5D=reservation_completed_at&headers%5B9%5D=event_name&headers%5B10%5D=first_scan_in_date&title=Item%20attendance%20report&order=-reservation_completed_at&template=1",
          "rank": 2
        }
      ],
      "totalCount": 2,
      "additionalCount": 0,
      "capacity": {
        "remaining": 998,
        "total": 1000,
        "used": 2,
        "usage": "0.20"
      }
    },
    "priceBands": {
      "salesVolume": "2.20",
      "salesUrl": "https://admin.ticketing-platform.com/v1/report?id=sales&filter%5Bhas_price_band%5D=1&filter%5Bevents%5D%5B0%5D=12&filter%5Bexclude_no_sales%5D=0&headers%5B0%5D=event_price_band_name&headers%5B1%5D=total_gross_currency_1&headers%5B2%5D=total_discounts_currency_1&headers%5B3%5D=total_online_refunds_currency_1&headers%5B4%5D=total_offline_refunds_currency_1&headers%5B5%5D=total_fees_currency_1&headers%5B6%5D=total_tax_currency_1&headers%5B7%5D=total_net_currency_1&headers%5B8%5D=total_gross_currency_2&headers%5B9%5D=total_discounts_currency_2&headers%5B10%5D=total_online_refunds_currency_2&headers%5B11%5D=total_offline_refunds_currency_2&headers%5B12%5D=total_fees_currency_2&headers%5B13%5D=total_tax_currency_2&headers%5B14%5D=total_net_currency_2&headers%5B15%5D=total_gross_currency_5&headers%5B16%5D=total_discounts_currency_5&headers%5B17%5D=total_online_refunds_currency_5&headers%5B18%5D=total_offline_refunds_currency_5&headers%5B19%5D=total_fees_currency_5&headers%5B20%5D=total_tax_currency_5&headers%5B21%5D=total_net_currency_5&title=Event%20sales%20report&template=1&grouping=sale_item_id",
      "soldQuantity": 2,
      "soldUrl": "https://admin.ticketing-platform.com/v1/report?id=attendance&filter%5Bstatuses%5D%5B0%5D=valid&filter%5Bhas_price_band%5D=1&filter%5Bevents%5D%5B0%5D=12&headers%5B0%5D=barcode&headers%5B3%5D=purchaser_email&headers%5B4%5D=item_holder_email&headers%5B5%5D=item_name&headers%5B6%5D=item_status&headers%5B7%5D=order_reference&headers%5B8%5D=reservation_completed_at&headers%5B9%5D=event_name&headers%5B10%5D=first_scan_in_date&title=Item%20attendance%20report&order=-reservation_completed_at&template=1",
      "top4": [
        {
          "id": 2,
          "name": "DEFAULT",
          "sales": "2.20",
          "quantity": 2,
          "url": "https://admin.ticketing-platform.com/v1/report?id=attendance&filter%5Bstatuses%5D%5B0%5D=valid&filter%5Bhas_price_band%5D=1&filter%5Bevents%5D%5B0%5D=12&filter%5Bprice_band_name%5D=DEFAULT&headers%5B0%5D=barcode&headers%5B3%5D=purchaser_email&headers%5B4%5D=item_holder_email&headers%5B5%5D=item_name&headers%5B6%5D=item_status&headers%5B7%5D=order_reference&headers%5B8%5D=reservation_completed_at&headers%5B9%5D=event_name&headers%5B10%5D=first_scan_in_date&title=Item%20attendance%20report&order=-reservation_completed_at&template=1",
          "rank": 1
        }
      ],
      "totalCount": 1,
      "additionalCount": 0,
      "capacity": {
        "remaining": "682",
        "total": "684",
        "used": 2,
        "usage": 0.29
      }
    }
  },
  "meta": {
    "generatedAt": "2023-09-04T14:11:04.524610+02:00",
    "dateRange": {
      "from": "2023-03-01T12:56:59.33123+02:00",
      "until": "2023-09-04T14:11:04.524610+02:00"
    }
  }
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
eventId
integer
required

The event ID you wish to retrieve aggregate event statistics for.

ā€‹
currencyId
integer

The currency ID to retrieve results in. Where events are on sale across multi-currencies, multiple calls to this endpoint may be required to retrieve all data. The default setting is the company default.

ā€‹
from
string | null

The date/time from which statistics will be calculated (inclusive). When null, the event creation date will be used. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
until
string | null

The date/time until which statistics will be calculated (inclusive). When null, 'now' will be used. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
orderTop4BySalesVolume
boolean

If set to true the top 4 for each item type will be sorted by total sales value, rather than quantity.

ā€‹
unformatted
boolean

When set to true values will be returned unformatted, as integers.

Response

Successful request to fetch event statistics.

ā€‹
data
object
ā€‹
meta
object