Machine-readable Spektrix Data
As well as providing tools which enable developers to integrate clients’ websites with our platform, we provide various different ways of accessing data held in client databases, in both human and machine-readable formats.
Machine-readable formats available within the Spektrix platform over and above our current API comprise these main components:
- Raw, row-level Spektrix data
- This same data grouped and aggregated (to deduplicate rows, and provide total figures)
- “Templated”, formatted, transformed data (to rename raw field names and values, and perform more bespoke groupings and aggregations)
Available data formats
The data formats in which this machine-readable data is available in are:
- For raw and simply-aggregated data
- XML
- CSV
- .xls and .xlsx Excel files
- For templated data
- .xls Excel files
- While not truly machine-readable, PDF outputs of this same data are possible
Access methods
There are several means available for accessing reports within Spektrix, all of which are available for all of the report types and formats mentioned above:
-
Manually running reports from within the “Insights & Mailings Interface” of the Spektrix system
- This requires a user account which is authorised to access all features of the Insights & Mailings interface, and as such is generally only suited to being accessed by the staff of our clients rather than Partners and other third parties
-
Manually running reports from within the “Partner Companies Interface”
- This is similar to the way reports can be manually run from the Insights & Mailings interface
-
Receiving reports via scheduled emails
- These can be setup to run hourly, daily, weekly or monthly, with reports being sent as either attachments or links where reports can be downloaded.
Raw data
Various different report types are available in Spektrix which can output data from different areas of the system, such as Events, Customers, and transactions.
When these reports are output in their raw forms, the names given to the columns are the same across all Spektrix client databases. For example, ticket prices are given the column name of “Price” in CSV/Excel format reports, and “OrderItems_Price” in XML format reports.
The raw data in these reports can be aggregated, for example by showing a sum of the price of all tickets rather than one row per ticket, or a count of all available seats.
If reports are needed with different column names or aggregations/groupings, then this can often be achieved via a templated report.
See the below examples and sample files for examples of how raw data is output in Excel/CSV and XML formatted reports.
| Event Name | Event Date/Time | Seat Status | Ticket Type | Price | Commission |
|---|---|---|---|---|---|
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 12 | 1 |
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 12 | 1 |
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 12 | 1 |
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 12 | 1 |
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 12 | 1 |
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 12 | 1 |
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 12 | 1 |
<Table1>
<Events_Name>Macbeth</Events_Name>
<EventInstances_Start>2020-08-31T19:30:00+00:00</EventInstances_Start>
<SeatStatuses_Name>Available</SeatStatuses_Name>
</Table1>
<Table1>
<Events_Name>Macbeth</Events_Name>
<EventInstances_Start>2020-08-31T19:30:00+00:00</EventInstances_Start>
<SeatStatuses_Name>Sold</SeatStatuses_Name>
<TicketTypes_Name>Adult</TicketTypes_Name>
<OrderItems_Price>12.00</OrderItems_Price>
<OrderItems_CalculatedCommission>1.00</OrderItems_CalculatedCommission>
</Table1>
Aggregated data
As well as being able to output raw data which is fully granular, it is also possible for that data to be grouped and aggregated at the row level, so that duplicate rows don’t appear, and so that numerical values can be totalled.
See the below screenshots and sample files for examples of how aggregated raw data is output in Excel/CSV and XML formatted reports.
| Event Name | Event Date/Time | Seat Status | Ticket Type | Sum of Price | Sum of Commission | Count |
|---|---|---|---|---|---|---|
| Macbeth | 2020-08-31 19:30 | Available | 141 | |||
| Macbeth | 2020-08-31 19:30 | Sold | Adult | 444 | 37 | 37 |
| Macbeth | 2020-08-31 19:30 | Sold | Comp | 0 | 0 | 3 |
| Macbeth | 2020-08-31 19:30 | Sold | Over 60 | 70 | 7 | 7 |
| Macbeth | 2020-08-31 19:30 | Sold | Student | 120 | 12 | 12 |
<Table1>
<Events_Name>Macbeth</Events_Name>
<EventInstances_Start>2020-08-31T19:30:00+00:00</EventInstances_Start>
<SeatStatuses_Name>Available</SeatStatuses_Name>
<SeatReportBase_>141</SeatReportBase_>
</Table1>
<Table1>
<Events_Name>Macbeth</Events_Name>
<EventInstances_Start>2020-08-31T19:30:00+00:00</EventInstances_Start>
<SeatStatuses_Name>Sold</SeatStatuses_Name>
<TicketTypes_Name>Adult</TicketTypes_Name>
<OrderItems_Price>444.00</OrderItems_Price>
<OrderItems_CalculatedCommission>37.00</OrderItems_CalculatedCommission>
<SeatReportBase_>37</SeatReportBase_>
</Table1>
<Table1>
<Events_Name>Macbeth</Events_Name>
<EventInstances_Start>2020-08-31T19:30:00+00:00</EventInstances_Start>
<SeatStatuses_Name>Sold</SeatStatuses_Name>
<TicketTypes_Name>Comp</TicketTypes_Name>
<OrderItems_Price>0.00</OrderItems_Price>
<OrderItems_CalculatedCommission>0.00</OrderItems_CalculatedCommission>
<SeatReportBase_>3</SeatReportBase_>
</Table1>
Templated reports
If reports are needed with different types of groupings or aggregations, or with columns named differently than in the raw data then Spektrix clients are able to request a bespoke “templated” report.
These templated reports can be output in PDF or Excel (specifically .xls) formats.
See the below sample files for examples of how templated reports output in Excel and PDF formatted reports.