Skip to main content
GET
/
events
/
{event}
/
stats
Get Event Statistics
curl --request GET \
  --url https://api.marzipan.co/v1/events/{event}/stats \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.marzipan.co/v1/events/{event}/stats"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.marzipan.co/v1/events/{event}/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.marzipan.co/v1/events/{event}/stats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.marzipan.co/v1/events/{event}/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.marzipan.co/v1/events/{event}/stats")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.marzipan.co/v1/events/{event}/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "ticketsSold": 58,
  "ticketsAvailable": 42,
  "maxTickets": 100,
  "maxTicketsPerOrder": 6,
  "totalRevenue": 2320,
  "outstandingRevenue": 150,
  "checkedIn": 12,
  "attending": 58,
  "waitlist": 3,
  "cancelled": 4
}
{
  "message": "No query results for model [Event]."
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Path Parameters

event
string<uuid>
required

The unique identifier of the event.

Response

Event statistics.

Aggregate statistics for an event. Revenue values are in the store's major currency unit.

ticketsSold
integer

The total number of tickets sold.

ticketsAvailable
integer

The number of tickets still available.

maxTickets
integer | null

The maximum ticket capacity, or null if uncapped.

maxTicketsPerOrder
integer | null

The maximum tickets allowed per order.

totalRevenue
number

Total revenue from tickets sold.

outstandingRevenue
number

Outstanding balances still due.

checkedIn
integer

The number of attendees checked in.

attending
integer

The number of tickets attending.

waitlist
integer

The number of pending waitlist entries.

cancelled
integer

The number of cancelled or refunded tickets.