Summary chart reports

Summary reports are a summarised version of the detailed chart reports. They indicate how many places are in a certain category or section.

Do note that these reports contain places, not objects. E.g.

{
  "generalAdmission": {
    "count": 80
  }
}

This means there are 80 places in general admission areas, not 80 individual GA areas.

A note on tables

If your floor plan contains tables, both seats at those tables and the tables themselves are counted by default. You can control this behaviour by passing in an optional bookWholeTables query parameter:

GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/{reportType}/summary?bookWholeTables=chart

• with bookWholeTables=chart, the report respects the table booking settings defined on the chart. If a table is bookable as a whole, the report contains the table (and not the seats). If a table is not bookable as a whole, the report contains the seats (and not the table).
• without the bookWholeTables query param, both seats at tables, and the tables themselves will be returned in the response
• with bookWholeTables=true, the response will only contain the tables, and not the seats.
• with bookWholeTables=false, the response will only contain the seats at the tables, and not the tables.
• with version=draft, the draft version of the chart will be used to generate the report.

Summary report by category label

Text

GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byCategoryLabel/summary
GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byCategoryLabel/summary?bookWholeTables=chart&version=draft

PHP

$seatsioClient->chartReports->summaryByCategoryLabel("chartKey");
$seatsioClient->chartReports->summaryByCategoryLabel("chartKey", "chart", "draft");

C#

await Client.ChartReports.SummaryByCategoryLabelAsync("chartKey");
await Client.ChartReports.SummaryByCategoryLabelAsync("chartKey", "chart", ChartReports.Version.Draft);

Java

client.chartReports.summaryByCategoryLabel("chartKey");
client.chartReports.summaryByCategoryLabel("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.CHART).version(ChartReportVersion.DRAFT));

Python

client.charts.reports.summary_by_category_label("chartKey")
client.charts.reports.summary_by_category_label("chartKey", "chart", "draft")

Ruby

client.chart_reports.summary_by_category_label("chartKey")
client.chart_reports.summary_by_category_label("chartKey", "chart", "draft")

Javascript

await client.chartReports.summaryByCategoryLabel('chartKey');
await client.chartReports.summaryByCategoryLabel('chartKey', 'chart', 'draft');

Go

chartReport, err := client.ChartReports.SummaryByCategoryLabel("chartKey")
chartReport, err := client.ChartReports.SummaryByCategoryLabel("chartKey", reports.ChartReportOptions.BookWholeTablesChart(), reports.ChartReportOptions.UseDraftVersion())

curl https://api-{region}.seatsio.net/reports/charts/someChartKey/byCategoryLabel/summary -u aSecretKey: 

{
    "premium": {
        "count": 34,
        "bySection": {
            "Floor": 12,
            "Balcony": 22
        },
        "byObjectType": { ... }
    },
    "standard": {
        "count": 80,
        "bySection": {
            "Balcony": 80
        },
        "byObjectType": { ... }
    },
    "NO_CATEGORY": {
        "count": 0,
        "bySection": {},
        "byObjectType": { ... }
    }
}

Summary report by category key

Text

GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byCategoryKey/summary
GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byCategoryKey/summary?bookWholeTables=chart&version=draft

PHP

$seatsioClient->chartReports->summaryByCategoryKey("chartKey");
$seatsioClient->chartReports->summaryByCategoryKey("chartKey", "chart", "draft");

C#

await Client.ChartReports.SummaryByCategoryKeyAsync("chartKey");
await Client.ChartReports.SummaryByCategoryKeyAsync("chartKey", "chart", ChartReports.Version.Draft);

Java

client.chartReports.summaryByCategoryKey("chartKey");
client.chartReports.summaryByCategoryKey("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.CHART).version(ChartReportVersion.DRAFT));

Python

client.charts.reports.summary_by_category_key("chartKey")
client.charts.reports.summary_by_category_key("chartKey", "chart", "draft")

Ruby

client.chart_reports.summary_by_category_key("chartKey")
client.chart_reports.summary_by_category_key("chartKey", "chart", "draft")

Javascript

await client.chartReports.summaryByCategoryKey('chartKey');
await client.chartReports.summaryByCategoryKey('chartKey', 'chart', 'draft');

Go

chartReport, err := client.ChartReports.SummaryByCategoryKey("chartKey")
chartReport, err := client.ChartReports.SummaryByCategoryKey("chartKey", reports.ChartReportOptions.BookWholeTablesChart(), reports.ChartReportOptions.UseDraftVersion())

curl https://api-{region}.seatsio.net/reports/charts/someChartKey/byCategoryKey/summary -u aSecretKey: 

{
    "1": {
        "count": 34,
        "bySection": {
            "Floor": 12,
            "Balcony": 22
        },
        "byObjectType": { ... }
    },
    "2": {
        "count": 80,
        "bySection": {
            "Balcony": 80
        },
        "byObjectType": { ... }
    },
    "NO_CATEGORY": {
        "count": 0,
        "bySection": {},
        "byObjectType": {}
    }
}

Summary report by section

Text

GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/bySection/summary
GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/bySection/summary?bookWholeTables=chart&version=draft

PHP

$seatsioClient->chartReports->summaryBySection("chartKey");
$seatsioClient->chartReports->summaryBySection("chartKey", "chart", "draft");

C#

await Client.ChartReports.SummaryBySectionAsync("chartKey");
await Client.ChartReports.SummaryBySectionAsync("chartKey", "chart", ChartReports.Version.Draft);

Java

client.chartReports.summaryBySection("chartKey");
client.chartReports.summaryBySection("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.CHART).version(ChartReportVersion.DRAFT));

Python

client.charts.reports.summary_by_section("chartKey")
client.charts.reports.summary_by_section("chartKey", "chart", "draft")

Ruby

client.chart_reports.summary_by_section("chartKey")
client.chart_reports.summary_by_section("chartKey", "chart", "draft")

Javascript

await client.chartReports.summaryBySection('chartKey');
await client.chartReports.summaryBySection('chartKey', 'chart', 'draft');

Go

chartReport, err := client.ChartReports.SummaryBySection("chartKey")
chartReport, err := client.ChartReports.SummaryBySection("chartKey", reports.ChartReportOptions.BookWholeTablesChart(), reports.ChartReportOptions.UseDraftVersion())

curl https://api-{region}.seatsio.net/reports/charts/someChartKey/bySection/summary -u aSecretKey: 

{
    "Floor": {
        "count": 34,
        "byCategoryLabel": {
            "premium": 10,
            "standard": 24
        },
        "byCategoryKey": {
            "1": 10,
            "2": 24
        },
        "byObjectType": { ... }
    },
    "Balcony": {
        "count": 80
        "byCategoryLabel": {
            "premium": 2,
            "standard": 78
        },
        "byCategoryKey": {
            "1": 2,
            "2": 78
        },
        "byObjectType": { ... }
    },
    "NO_SECTION": {
        "count": 0,
        "byCategoryLabel": {},
        "byCategoryKey": {},
      "byObjectType": {}
    }
}

Summary report by object type

Text

GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byObjectType/summary
GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byObjectType/summary?bookWholeTables=chart&version=draft

PHP

$seatsioClient->chartReports->summaryByObjectType("chartKey", "chart", "draft");
$seatsioClient->chartReports->summaryByObjectType("chartKey");
$seatsioClient->chartReports->summaryByObjectType("chartKey", "chart");
$seatsioClient->chartReports->summaryByObjectType("chartKey", "true");
$seatsioClient->chartReports->summaryByObjectType("chartKey", "false");
$seatsioClient->chartReports->summaryByObjectType("chartKey", null, "draft");

C#

await Client.ChartReports.SummaryByObjectTypeAsync("chartKey", "chart", ChartReports.Version.Draft);
await Client.ChartReports.SummaryByObjectTypeAsync("chartKey");
await Client.ChartReports.SummaryByObjectTypeAsync("chartKey", "chart");
await Client.ChartReports.SummaryByObjectTypeAsync("chartKey", "true");
await Client.ChartReports.SummaryByObjectTypeAsync("chartKey", "false");
await Client.ChartReports.SummaryByObjectTypeAsync("chartKey", version: ChartReports.Version.Draft);

Java

client.chartReports.summaryByObjectType("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.CHART).version(ChartReportVersion.DRAFT));
client.chartReports.summaryByObjectType("chartKey");
client.chartReports.summaryByObjectType("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.CHART));
client.chartReports.summaryByObjectType("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.TRUE)));
client.chartReports.summaryByObjectType("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.FALSE));
client.chartReports.summaryByObjectType("chartKey", new ChartReportOptions().version(ChartReportVersion.DRAFT));

// Deprecated
client.chartReports.summaryByObjectType("chartKey", ChartReportBookWholeTablesMode.CHART);
client.chartReports.summaryByObjectType("chartKey", ChartReportBookWholeTablesMode.TRUE);
client.chartReports.summaryByObjectType("chartKey", ChartReportBookWholeTablesMode.FALSE);

Python

client.charts.reports.summary_by_object_type("chartKey")
client.charts.reports.summary_by_object_type("chartKey", "chart", "draft")

Ruby

client.chart_reports.summary_by_object_type("chartKey")
client.chart_reports.summary_by_object_type("chartKey", "chart", "draft")

Javascript

await client.chartReports.summaryByObjectType('chartKey');
await client.chartReports.summaryByObjectType('chartKey', 'chart', 'draft');

Go

chartReport, err := client.ChartReports.SummaryByObjectType("chartKey")
chartReport, err := client.ChartReports.SummaryByObjectType("chartKey", reports.ChartReportOptions.BookWholeTablesChart(), reports.ChartReportOptions.UseDraftVersion())

curl https://api-{region}.seatsio.net/reports/charts/someChartKey/byObjectType/summary -u aSecretKey: 

Example response

{
    "seat": {
        "count": 34,
        "bySection": {
            "Floor": 12,
            "Balcony": 22
        },
        "byCategoryLabel": {
            "premium": 10,
            "standard": 24
        },
        "byCategoryKey": {
            "1": 10,
            "2": 24
        }
    },
    "generalAdmission": {
        "count": 80,
        "bySection": {
            "Balcony": 80
        },
        "byCategoryLabel": {
            "premium": 2,
            "standard": 78
        },
        "byCategoryKey": {
            "1": 2,
            "2": 78
        }
    },
    "booth": {
        "count": 80,
        "bySection": {
            "Balcony": 80
        },
        "byCategoryLabel": {
            "premium": 2,
            "standard": 78
        },
        "byCategoryKey": {
            "1": 2,
            "2": 78
        }
    },
    "table": {
        "count": 80,
        "bySection": {
            "Balcony": 80
        },
        "byCategoryLabel": {
            "premium": 2,
            "standard": 78
        },
        "byCategoryKey": {
            "1": 2,
            "2": 78
        }
    }
}

Summary report by zone

Text

GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byZone/summary
GET https://api-{region}.seatsio.net/reports/charts/{chartKey}/byZone/summary?bookWholeTables=chart&version=draft

PHP

$seatsioClient->chartReports->summaryByZone("chartKey");
$seatsioClient->chartReports->summaryByZone("chartKey", "chart", "draft");

C#

await Client.ChartReports.SummaryByZoneAsync("chartKey");
await Client.ChartReports.SummaryByZoneAsync("chartKey", "chart", ChartReports.Version.Draft);

Java

client.chartReports.summaryByZone("chartKey");
client.chartReports.summaryByZone("chartKey", new ChartReportOptions().bookWholeTablesMode(ChartReportBookWholeTablesMode.CHART).version(ChartReportVersion.DRAFT));

Python

client.charts.reports.summary_by_zone("chartKey")
client.charts.reports.summary_by_zone("chartKey", "chart", "draft")

Ruby

client.chart_reports.summary_by_zone("chartKey")
client.chart_reports.summary_by_zone("chartKey", "chart", "draft")

Javascript

await client.chartReports.summaryByZone('chartKey');
await client.chartReports.summaryByZone('chartKey', 'chart', 'draft');

Go

chartReport, err := client.ChartReports.SummaryByZone("chartKey")
chartReport, err := client.ChartReports.SummaryByZone("chartKey", reports.ChartReportOptions.BookWholeTablesChart(), reports.ChartReportOptions.UseDraftVersion())

curl https://api-{region}.seatsio.net/reports/charts/someChartKey/byZone/summary -u aSecretKey: 

{
    "Zone 1": {
        "count": 34,
        "byCategoryLabel": {
            "premium": 10,
            "standard": 24
        },
        "byCategoryKey": {
            "1": 10,
            "2": 24
        },
        "byObjectType": { ... }
    },
    "Zone 2": {
        "count": 80
        "byCategoryLabel": {
            "premium": 2,
            "standard": 78
        },
        "byCategoryKey": {
            "1": 2,
            "2": 78
        },
        "byObjectType": { ... }
    },
    "NO_ZONE": {
        "count": 0,
        "byCategoryLabel": {},
        "byCategoryKey": {},
      "byObjectType": {}
    }
}