Swarmtix Help Center
Tool Reference

swarmtix_analytics_summary

A roll-up across the organisation — events, tickets sold, orders placed, and lifetime gross ticket revenue per currency

swarmtix_analytics_summary

Returns a roll-up across this connection's organisation: how many events it has, how many tickets have sold and how many orders were placed across all of them, plus the lifetime gross ticket revenue for the events this organizer account owns — one figure per currency.

When you would reach for it

  • A one-line answer to "how are we doing overall?"
  • A starting point before drilling into one event with swarmtix_analytics_event.
  • A sanity check that the connection is pointed at the organisation you think it is — the counts will tell you quickly.

Scope

analytics:read

Figures only. No names, no email addresses, no per-order detail.

Parameters

None. The organisation and the organizer account both come from the access token.

Example call

{
  "name": "swarmtix_analytics_summary",
  "arguments": {}
}

What comes back

{
  "organizationId": "e3a58c71-6b04-4d29-9f8e-2c71a05b4d63",
  "organization": {
    "events": 37,
    "ticketsSold": 21480,
    "ordersPlaced": 9312
  },
  "organizerAccount": {
    "userId": "1d7f4b90-2c85-4e63-a018-9b5d6f2a3c47",
    "lifetimeGrossTicketRevenueByCurrency": [
      { "currency": "EUR", "grossTicketRevenue": 512430.0 },
      { "currency": "USD", "grossTicketRevenue": 171785.5 }
    ],
    "includesRefundedAndCancelledTickets": true
  }
}

Two different scopings, named as such

The two halves of this response do not cover the same set of events, and the response is shaped that way so the difference cannot be missed.

FieldWhat it counts
organization.eventsEvery event in the organisation this connection was granted
organization.ticketsSoldActive, non-refunded tickets across all of the organisation's events
organization.ordersPlacedActive orders across all of the organisation's events
organizerAccount.userIdThe organizer account this connection authorizes as
organizerAccount.lifetimeGrossTicketRevenueByCurrencyOne entry per currency the account has sold in — the summed face price of every ordered ticket on the events that account owns, split by the currency each event sells in
organizerAccount.includesRefundedAndCancelledTicketsAlways true — see below

For an organisation with one organizer the two coincide. For an organisation with several, they do not: the revenue figures cover the events this account created, and the counts above them cover every event in the organisation.

The revenue is split by currency, and there is no combined total

An organisation running one event in EUR and another in USD has no single lifetime figure, so this tool does not report one. €10 plus $10 is not 20 of anything.

lifetimeGrossTicketRevenueByCurrency is a list with one entry per currency the account has actually sold in, each naming its ISO 4217 code. It is a list even when there is only one entry — a bare number carries nothing that would let you notice it had quietly become a mix.

Each entry's currency is the code from the event row. The symbol is deliberately not here: $ is four different currencies, so grouping on it would either merge two of them into one figure or split one currency across two entries wherever the event rows spell its symbol differently. The code means exactly one thing.

An account that has never sold a ticket gets an empty list — "nothing sold", without claiming a currency it does not have.

The revenue figures are gross, and they say so

Each grossTicketRevenue is named for what it actually measures. It sums the face price of every ordered ticket on the events that account owns, without excluding refunded, cancelled or inactive tickets, and without counting service fees.

includesRefundedAndCancelledTickets is on every response as a standing reminder. Calling the numbers "revenue" unqualified would overstate them, which is why the field is spelled out rather than shortened.

For a figure that nets refunds off, read one event at a time with swarmtix_analytics_event, which reports totalRevenue and refundedAmount separately.

What happens when you call it

  1. Three counts are run against the organisation on the token: events, active non-refunded tickets, active orders.
  2. The lifetime gross revenue is summed for the organizer account on the token, grouped by the currency each event sells in.
  3. The two are returned side by side, each under a label naming what it covers.

The roll-up is computed here rather than taken wholesale from one place, because the revenue is the only figure scoped by account and everything else on this surface is scoped by organisation. Presenting one combined total would have meant quietly picking one of the two scopings and hoping it was the one you wanted.

Troubleshooting

The revenue looks too high

It is gross. Refunded and cancelled tickets are included — that is what includesRefundedAndCancelledTickets is telling you. Service fees are not included, so it is not a payout figure either.

The revenue looks too low for the organisation

It covers only the events the authorizing organizer account owns. If colleagues created events under their own accounts, those are in organization.events but not in these numbers. swarmtix_whoami names which account you are connected as.

One entry has a currency of null

There is one entry per distinct currency code on the events that account owns, and an old event left without one lands here. The figure is real; which currency it is in is not recorded anywhere. Set the event's currency to make it join the right entry.

lifetimeGrossTicketRevenueByCurrency is an empty list

That account has never sold a ticket on an event it owns. The organisation counts above it may still be non-zero, because they cover events colleagues own too.

The event count does not match your dashboard

organization.events counts every event in the organisation, including drafts and past events. The dashboard may be filtering to upcoming or published ones.

"This connection is not authorized for analytics:read. Reconnect and grant it to use this tool."

Reconnect and approve analytics:read.

"Swarmtix could not complete this request. Nothing was changed."

A query behind the roll-up failed. Retry; if it persists, quote the time to support.

Use cases

  • Monthly board line — events, tickets, orders, in one call
  • Year-on-year context before opening one event's analytics
  • Confirming which organisation a connection covers
  • Spotting a scoping surprise — when the account figures and the organisation figures diverge, someone else is creating events
  • Noticing a second currency — a new entry in the list is an event selling somewhere it did not before

On this page