Seats.io

https://docs.seats.io/docs
Admin
Seats.io is a seating chart and floor plan solution that integrates into ticketing platforms,...
Tokens:399,919
Snippets:2,900
Trust Score:8.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Go CreateMultiple example

Source: https://docs.seats.io/docs/api/create-multiple-events

Go example using the Seatsio client to create multiple events with table booking configurations. Uses client.Events.CreateMultiple with CreateMultipleEventParams.

```go
events, err := client.Events.CreateMultiple(  
	"chartKey",  
	events.CreateMultipleEventParams{  
	    EventParams: &events.EventParams{  
	        TableBookingConfig: events.TableBookingSupport.AllByTables(),  
	    },  
	},  
	events.CreateMultipleEventParams{  
	    EventParams: &events.EventParams{  
		    EventKey:           "aSpecificEventKey",  
		    TableBookingConfig: events.TableBookingSupport.AllBySeat(),  
	    },  
	},  
)
```

--------------------------------

### Response example

Source: https://docs.seats.io/docs/api/create-events-in-season

Example response from the create-events endpoint, showing the created events.

```json
{
  "events": [
    {
      "id": 171,
      "key": "event2",
      ...
    },
    {
      "id": 170,
      "key": "event1",
      ...
    }
  ]
}
```

--------------------------------

### Go EditForSaleConfig examples

Source: https://docs.seats.io/docs/api/edit-for-sale-config

Go example using EditForSaleConfig to mark seats as not for sale, for sale again, and a quantity of GA1 as not for sale. Requires a request context.

```go
// Mark seats A-1 and A-2 as not for sale  

client.Events.EditForSaleConfig(test_util.RequestContext(), event.Key, nil, []events.ObjectAndQuantity{{Object: "A-1"}, {Object: "A-2"}})  

  

// Mark seats A-1 and A-2 as for sale again, if they were previously marked as not for sale  

client.Events.EditForSaleConfig(test_util.RequestContext(), event.Key, []events.ObjectAndQuantity{{Object: "A-1"}, {Object: "A-2"}})  

  

// Mark 5 places in GA1 as not for sale  

client.Events.EditForSaleConfig(test_util.RequestContext(), event.Key, nil, []events.ObjectAndQuantity{{Object: "GA1", Quantity: 5}})
```

--------------------------------

### Python create_multiple example

Source: https://docs.seats.io/docs/api/create-multiple-events

Python example using the Seatsio client to create multiple events with table booking configurations. Uses EventProperties and client.events.create_multiple.

```python
eventProps = [  
  EventProperties(event_key="event34", table_booking_config=TableBookingConfig.all_by_table()),  
  EventProperties(event_key="event35", table_booking_config=TableBookingConfig.all_by_seat())  
]  

  

events = client.events.create_multiple("4250fffc-e41f-c7cb-986a-2c5e728b8c28", eventProps);
```

--------------------------------

### C#: ChangeObjectStatusAsync examples

Source: https://docs.seats.io/docs/api/change-object-status-in-batch

C# client examples for booking, holding, releasing, re-holding booked seats, overriding season status, and using season status. Note the syntax error in the re-holding example (missing 'status:' before 'free').

```csharp
// Booking seats  

await Client.Events.ChangeObjectStatusAsync(new[] {  

	new StatusChangeRequest(eventKey: "event1", objects: new[] {"A-3", "A-5"}, status: "booked"),  

	new StatusChangeRequest(eventKey: "event2", objects: new[] {"B-27"}, status: "booked"),  

});  

  

// Holding seats  

await Client.Events.ChangeObjectStatusAsync(new[] {  

	new StatusChangeRequest(eventKey: "event1", objects: new[] {"A-3", "A-5"}, status: "reservedByToken", holdToken: "wvXbB9MlHt"),  

	new StatusChangeRequest(eventKey: "event2", objects: new[] {"B-27"}, status: "reservedByToken", holdToken: "wvXbB9MlHt"),  

});  

  

// Releasing seats  

await Client.Events.ChangeObjectStatusAsync(new[] {  

	new StatusChangeRequest(type: StatusChangeRequest.RELEASE, eventKey: "event1", objects: new[] {"A-3", "A-5"}),  

	new StatusChangeRequest(type: StatusChangeRequest.RELEASE, eventKey: "event2", objects: new[] {"B-27"}),  

});  

  

// Re-holding booked seats  

await Client.Events.ChangeObjectStatusAsync(new[] {  

    new StatusChangeRequest(eventKey: "myEvent", objects: new[] {"A-3", "A-5"}, "free"),  

	new StatusChangeRequest(eventKey: "myEvent", objects: new[] {  

	    new ObjectProperties("A-3", "adult"),   

	    new ObjectProperties("A-5", "child")  

	}, status: "reservedByToken", holdToken: "wvXbB9MlHt"),  

});  

  

// Overriding the season status  

await Client.Events.ChangeObjectStatusAsync(new[] {  

	new StatusChangeRequest(type: StatusChangeRequest.OVERRIDE_SEASON_STATUS, eventKey: "event1", objects: new[] {"A-3", "A-5"})  

});  

  

// Using the season status  

await Client.Events.ChangeObjectStatusAsync(new[] {  

	new StatusChangeRequest(type: StatusChangeRequest.USE_SEASON_STATUS, eventKey: "event1", objects: new[] {"A-3", "A-5"})  

});  
```

--------------------------------

### Example parameters object

Source: https://docs.seats.io/docs/renderer/prompts-api/onPlacesPrompt

Example of the parameters object passed to onPlacesPrompt, showing selectedPlaces, minPlaces, maxPlaces, and objectToSelect.

```javascript
{  

	selectedPlaces: 1,  

	minPlaces: 0,  

	maxPlaces: 10,  

	objectToSelect: {  

		// ...  

		label: "General Admission",  

		// ...  

	}  

}
```

--------------------------------

### Request body examples

Source: https://docs.seats.io/docs/api/create-events-in-season

Two request body examples: one with event keys, one with number of events.

```json
// with event keys to create (those events should not yet exist)
{
  "eventKeys": ["event1", "event2"]
}

// with number of events
{
  "numberOfEvents": 2
}
```

--------------------------------

### Java editForSaleConfig examples

Source: https://docs.seats.io/docs/api/edit-for-sale-config

Java example using editForSaleConfig to mark seats as not for sale, for sale again, and a quantity of GA1 as not for sale.

```java
// Mark seats A-1 and A-2 as not for sale  

client.events.editForSaleConfig(event.key(), null, List.of(new ObjectAndQuantity("A-1"), new ObjectAndQuantity("A-2")));  

  

// Mark seats A-1 and A-2 as for sale again, if they were previously marked as not for sale  

client.events.editForSaleConfig(event.key(), List.of(new ObjectAndQuantity("A-1"), new ObjectAndQuantity("A-2")));  

  

// Mark 5 places in GA1 as not for sale  

client.events.editForSaleConfig(event.key(), null, List.of(new ObjectAndQuantity("GA1", 5)));
```

--------------------------------

### Response example

Source: https://docs.seats.io/docs/api/create-partial-season

Example response from the API after creating a partial season. Shows the structure including id, eventKey, tableBookingConfig, and events array.

```json
{  
  "id": 169,  
  "eventKey": "aPartialSeason",  
  "tableBookingConfig": {  
    "mode": "CUSTOM",  
    "tables": { "T1": "BY_TABLE", "T2": "BY_SEAT" }  
  },  
  "supportsBestAvailable": true,  
  "createdOn": "2017-05-05T10:58:44.715Z",  
  "isSeason": true,  
  "isTopLevelSeason": false,  
  "isPartialSeason": true,  
  "isEventInSeason": false,  
  "topLevelSeasonKey": "aSeason",  
  "events": [  
    {  
      "id": 170,  
      "key": "event1",  
      ...  
    },  
    ...  
  ]  
}  
```

--------------------------------

### Python edit_for_sale_config examples

Source: https://docs.seats.io/docs/api/edit-for-sale-config

Python example using edit_for_sale_config to mark seats as not for sale, for sale again, and a quantity of GA1 as not for sale.

```python
# Mark seats A-1 and A-2 as not for sale  

client.events.edit_for_sale_config(event.key, None, [{ object: "A-1"}, { object: "A-2"}])  

  

# Mark seats A-1 and A-2 as for sale again, if they were previously marked as not for sale  

client.events.edit_for_sale_config(event.key, [{ object: "A-1"}, { object: "A-2"}])  

  

# Mark 5 places in GA1 as not for sale  

client.events.edit_for_sale_config(event.key, None, [{ object: "GA1", quantity: 5}])
```

--------------------------------

### Request body example

Source: https://docs.seats.io/docs/api/create-multiple-events

Example request body for the create-multiple endpoint. Shows eventKey, tableBookingConfig modes, and forSaleConfig with objects, areaPlaces, and categories.

```json
{  
  "chartKey": "4250fffc-e41f-c7cb-986a-2c5e728b8c28",  
  "events": [  
    {   
      "eventKey": "event34",  
      "tableBookingConfig": { "mode": "ALL_BY_TABLE" }  
    },  
    {  
      "eventKey": "event35",  
      "tableBookingConfig": { "mode": "ALL_BY_SEAT" },  
      "forSaleConfig": {  
        "forSale": false,  
        "objects": ["section1", "section2"],  
        "areaPlaces": {"GA1":  3},  
        "categories": ["eventCategory1", "eventCategory2"]  
      }  
    }  
  ]  
}
```

--------------------------------

### Ruby edit_for_sale_config examples

Source: https://docs.seats.io/docs/api/edit-for-sale-config

Ruby example using edit_for_sale_config with keyword arguments to mark seats as not for sale, for sale again, and a quantity of GA1 as not for sale.

```ruby
# Mark seats A-1 and A-2 as not for sale  

client.events.edit_for_sale_config key: event.key, not_for_sale: [{ object: "A-1"}, { object: "A-2"}]  

  

# Mark seats A-1 and A-2 as for sale again, if they were previously marked as not for sale  

client.events.edit_for_sale_config key: event.key, for_sale: [{ object: "A-1"}, { object: "A-2"}]  

  

# Mark 5 places in GA1 as not for sale  

client.events.edit_for_sale_config key: event.key, not_for_sale: [{ object: "GA1", quantity: 5}]
```

--------------------------------

### GET /events

Source: https://docs.seats.io/docs/api/list-events

This snippet documents the GET /events endpoint, which lists all events in the account. It includes the request example and the response structure with event details.

```APIDOC
## [GET] /events

### Description
Lists all events in the account. The response is paginated and includes event details such as key, chart key, and creation date.

### Method
GET

### Endpoint
https://api-{region}.seatsio.net/events

### Parameters
#### Authentication
- **u** (string) - Required - Secret key for authentication.

### Request Example
```
curl https://api-{region}.seatsio.net/events \
  -u aSecretKey:
```

### Response
#### Success Response (200)
- **next_page_starts_after** (integer) - Cursor for the next page.
- **items** (array) - List of events.
  - **id** (integer) - Event ID.
  - **key** (string) - Event key.
  - **tableBookingConfig** (object) - Table booking configuration (if applicable).
    - **mode** (string) - Mode of table booking.
    - **tables** (object) - Mapping of table IDs to booking modes.
  - **chartKey** (string) - Chart key.
  - **isSeason** (boolean) - Whether the event is a season.
  - **isTopLevelSeason** (boolean) - Whether the event is a top-level season.
  - **isPartialSeason** (boolean) - Whether the event is a partial season.
  - **isEventInSeason** (boolean) - Whether the event is part of a season.
  - **createdOn** (string) - Creation timestamp.
  - **updatedOn** (string) - Last update timestamp (if present).

#### Response Example
```
{
  "next_page_starts_after": 122,
  "items": [
    {
      "id": 169,
      "key": "anEvent",
      "tableBookingConfig": {
        "mode": "CUSTOM",
        "tables": {
          "T1": "BY_TABLE",
          "T2": "BY_SEAT",
          "T3": "BY_TABLE"
        }
      },
      "chartKey": "4250fffc-e41f-c7cb-986a-2c5e728b8c28",
      "isSeason": false,
      "isTopLevelSeason": false,
      "isPartialSeason": false,
      "isEventInSeason": false,
      "createdOn": "2017-05-05T10:58:44.715Z"
    },
    {
      "id": 168,
      "key": "anotherEvent",
      "chartKey": "4150dddc-e41f-c7cb-986a-2c5e728b8c20",
      "isSeason": false,
      "isTopLevelSeason": false,
      "isPartialSeason": false,
      "isEventInSeason": false,
      "createdOn": "2017-03-05T10:58:44.715Z",
      "updatedOn": "2017-04-05T10:58:44.615Z"
    }
  ]
}
```
```

--------------------------------

### Go client example for SummaryByCategoryKey

Source: https://docs.seats.io/docs/api/chart-reports/summary

Two Go calls: one with just the chart key, another with options for BookWholeTablesChart and UseDraftVersion.

```go
chartReport, err := client.ChartReports.SummaryByCategoryKey("chartKey")  

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

```

--------------------------------

### GET /charts

Source: https://docs.seats.io/docs/api/authentication

Example of a raw HTTP call to the charts endpoint using Basic authentication.

```APIDOC
## [GET] /charts

### Description
Retrieves a list of charts. Requires authentication via an Authorization header with Basic authentication.

### Method
GET

### Endpoint
https://api-{region}.seatsio.net/charts

### Parameters
#### Headers
- **Authorization** (string) - Required - Basic authentication header. Format: `Basic <base64(secretKey:)>`.
- **X-Workspace-Key** (string) - Optional - Public workspace key. Used when authenticating with a company admin key or sandbox admin key to specify the workspace.

### Request Example
```
curl https://api-{region}.seatsio.net/charts -H "Authorization: Basic NTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwOg=="
```

### Response
#### Success Response (200)
Returns a list of charts. The response body is not specified in the source.

#### Response Example
Not provided in the source.
```

--------------------------------

### Go client authentication examples

Source: https://docs.seats.io/docs/api/authentication

Shows three Go client initialization patterns: workspace secret key, company/sandbox admin key, and admin key with workspace public key for both call types.

```go
import (  
    "github.com/seatsio/seatsio-go"  
)  

  

// for calls within a workspace (e.g. booking a seat)  

client := seatsio.NewSeatsioClient(seatsio.EU, <WORKSPACE SECRET KEY>)  

  

// for calls not specific to a workspace (e.g. listing all workspaces)  

client := seatsio.NewSeatsioClient(seatsio.EU, <COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>)  

  

// for calls within a workspace (e.g. booking a seat)  

// AND calls not specific to a workspace (e.g. listing all workspaces)  

client := seatsio.NewSeatsioClient(seatsio.EU, <COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>, seatsio.ClientSupport.WorkspaceKey(<WORKSPACE PUBLIC KEY>))  


```

--------------------------------

### Go CreatePartialSeason examples

Source: https://docs.seats.io/docs/api/create-partial-season

Go examples for creating a partial season. The first call uses the default key, the second specifies a partial season key, and the third adds event keys.

```go
partialSeason, err := client.Seasons.CreatePartialSeason("aTopLevelSeason")  

partialSeason, err := client.Seasons.CreatePartialSeasonWithOptions(  
	"aTopLevelSeason",  
	&seasons.CreatePartialSeasonParams{Key: "aPartialSeason"},  
)  

partialSeason, err := client.Seasons.CreatePartialSeasonWithOptions(  
	"aTopLevelSeason",  
	&seasons.CreatePartialSeasonParams{EventKeys: []string{"event1", "event3"}},  
)  
```

--------------------------------

### Go SummaryByObjectType

Source: https://docs.seats.io/docs/api/events-reports/summary

Go example using the Seats.io client to get a summary report by object type for event 'eventKey'.

```go
report, err := client.EventReports.SummaryByObjectType("eventKey")
```

--------------------------------

### Go: create a season with various options

Source: https://docs.seats.io/docs/api/create-season

Shows how to create a season using the Go client. Includes examples for basic creation, custom key, number of events, event keys, and custom table booking config.

```go
season, err := client.Seasons.CreateSeason("749b9650-24fb-11e7-93ae-92361f002671") // chart key

season, err := client.Seasons.CreateSeasonWithOptions("749b9650-24fb-11e7-93ae-92361f002671", &seasons.CreateSeasonParams{
    Key: "aSeasonKey",
})

season, err := client.Seasons.CreateSeasonWithOptions("749b9650-24fb-11e7-93ae-92361f002671", &seasons.CreateSeasonParams{
    NumberOfEvents: 2,
})

season, err := client.Seasons.CreateSeasonWithOptions("749b9650-24fb-11e7-93ae-92361f002671", &seasons.CreateSeasonParams{
    EventKeys: []string{"event1", "event2"},
})

season, err := client.Seasons.CreateSeasonWithOptions("749b9650-24fb-11e7-93ae-92361f002671", &seasons.CreateSeasonParams{
    TableBookingConfig: &events.TableBookingConfig{
        Mode:   events.CUSTOM,
        Tables: map[string]events.TableBookingMode{
            "T1": events.BY_TABLE,
            "T2": events.BY_SEAT,
        },
    },
})
```

--------------------------------

### Ruby summary_by_object_type

Source: https://docs.seats.io/docs/api/events-reports/summary

Ruby example using the Seats.io client to get a summary report by object type for event 'event34'.

```ruby
client.event_reports.summary_by_object_type("event34")
```

--------------------------------

### Java client example for summaryByCategoryKey

Source: https://docs.seats.io/docs/api/chart-reports/summary

Two Java calls: one with just the chart key, another with ChartReportOptions for bookWholeTablesMode and version.

```java
client.chartReports.summaryByCategoryKey("chartKey");  

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

```

--------------------------------

### Python summary_by_object_type

Source: https://docs.seats.io/docs/api/events-reports/summary

Python example using the Seats.io client to get a summary report by object type for event 'event34'.

```python
client.events.reports.summary_by_object_type("event34")
```

--------------------------------

### Java summaryByObjectType

Source: https://docs.seats.io/docs/api/events-reports/summary

Java example using the Seats.io client to get a summary report by object type for event 'event34'.

```java
client.eventReports.summaryByObjectType("event34");
```

--------------------------------

### PHP createMultiple example

Source: https://docs.seats.io/docs/api/create-multiple-events

PHP example using the Seatsio client to create multiple events with table booking configurations. Requires a Seatsio client instance and a chart key.

```php
$params = [  

	CreateEventParams::create()  

    ->setKey("event34")  

    ->setTableBookingConfig(TableBookingConfig::allByTable()),  

	CreateEventParams::create()  

    ->setKey("event35")  

    ->setTableBookingConfig(TableBookingConfig::allBySeat())  

];  

  

$events = $seatsioClient->events->createMultiple("4250fffc-e41f-c7cb-986a-2c5e728b8c28", $params);
```

--------------------------------

### PHP client authentication examples

Source: https://docs.seats.io/docs/api/authentication

Shows three PHP client initialization patterns: workspace secret key, company/sandbox admin key, and admin key with workspace public key for both call types.

```php
use Seatsio\Region;  

use Seatsio\SeatsioClient;  

  

// for calls within a workspace (e.g. booking a seat)  

$client = new SeatsioClient(Region::EU(), <WORKSPACE SECRET KEY>);  

  

// for calls not specific to a workspace (e.g. listing all workspaces)  

$client = new SeatsioClient(Region::EU(), <COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>);  

  

// for calls within a workspace (e.g. booking a seat)  

// AND calls not specific to a workspace (e.g. listing all workspaces)  

$client = new SeatsioClient(Region::EU(), <COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>, <WORKSPACE PUBLIC KEY>);  


```

--------------------------------

### PHP summaryByObjectType

Source: https://docs.seats.io/docs/api/events-reports/summary

PHP example using the Seats.io client to get a summary report by object type for event 'event34'.

```php
$seatsioClient->eventReports->summaryByObjectType("event34");
```

--------------------------------

### Go ReplaceForSaleConfig example

Source: https://docs.seats.io/docs/api/replace-for-sale-config

Go example showing how to replace the for sale config for an event. The first call makes the specified objects for sale, the second makes them not for sale.

```go
// Make for sale  

err = client.Events.ReplaceForSaleConfig("eventKey", true, &events.ForSaleConfigParams{  
    Objects:    []string{"A-1", "A-2"},  
    AreaPlaces: map[string]int{"GA1": 3},  
    Categories: []string{"category1", "category2"},  
})  

  

// Make not for sale  

err = client.Events.ReplaceForSaleConfig("eventKey", false, &events.ForSaleConfigParams{  
Objects:    []string{"A-1", "A-2"},  
AreaPlaces: map[string]int{"GA1": 3},  
Categories: []string{"category1", "category2"},  
})  
```

--------------------------------

### JavaScript summaryByObjectType

Source: https://docs.seats.io/docs/api/events-reports/summary

JavaScript example using the Seats.io client to asynchronously get a summary report by object type for event 'eventKey'.

```javascript
await client.eventReports.summaryByObjectType('eventKey');
```

--------------------------------

### C# SummaryByObjectTypeAsync

Source: https://docs.seats.io/docs/api/events-reports/summary

C# example using the Seats.io client to asynchronously get a summary report by object type for event 'event34'.

```csharp
await Client.EventReports.SummaryByObjectTypeAsync("event34");
```

--------------------------------

### Java client authentication examples

Source: https://docs.seats.io/docs/api/authentication

Shows three Java client initialization patterns: workspace secret key, company/sandbox admin key, and admin key with workspace public key for both call types.

```java
import seatsio.SeatsioClient;  

import seatsio.Region;  

  

// for calls within a workspace (e.g. booking a seat)  

SeatsioClient client = new SeatsioClient(Region.EU, "<WORKSPACE SECRET KEY>");  

  

// for calls not specific to a workspace (e.g. listing all workspaces)  

SeatsioClient client = new SeatsioClient(Region.EU, "<COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>");  

  

// for calls within a workspace (e.g. booking a seat)  

// AND calls not specific to a workspace (e.g. listing all workspaces)  

SeatsioClient client = new SeatsioClient(Region.EU, "<COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>", "<WORKSPACE PUBLIC KEY>");  


```

--------------------------------

### Go: WithSeasonBookingsNotPropagated() and ByAvailabilityReason()

Source: https://docs.seats.io/docs/api/events-reports/flat

Go example using the seatsio client to get event reports without propagated season bookings.

```go
withoutPropagation := client.EventReports.WithSeasonBookingsNotPropagated()  

report, err := withoutPropagation.ByAvailabilityReason("season34")  

items, err := withoutPropagation.BySpecificAvailabilityReason("season34", reports.Available)  

items, err := withoutPropagation.BySpecificAvailabilityReason("eventInSeason34", reports.Booked)  

```

--------------------------------

### Go: Book with extraData

Source: https://docs.seats.io/docs/api/extra-data

Go example using events.ObjectProperties with ExtraData map and BookWithObjectProperties.

```go
object1 := events.ObjectProperties{ObjectId: "A-5", ExtraData: map[string]string{"userId": "123"}}  
object2 := events.ObjectProperties{ObjectId: "A-6", ExtraData: map[string]string{"userId": "456"}}  
result, err := client.Events.BookWithObjectProperties("eventKey", object1, object2)  
```

--------------------------------

### JavaScript: withSeasonBookingsNotPropagated() and byAvailabilityReason()

Source: https://docs.seats.io/docs/api/events-reports/flat

JavaScript example using the seatsio client to get event reports without propagated season bookings.

```javascript
const withoutPropagation = client.eventReports.withSeasonBookingsNotPropagated()  

await withoutPropagation.byAvailabilityReason('season34');  

await withoutPropagation.byAvailabilityReason('season34', 'available');  

await withoutPropagation.byAvailabilityReason('eventInSeason34', 'booked');  

```

--------------------------------

### PHP client example for summaryByCategoryKey

Source: https://docs.seats.io/docs/api/chart-reports/summary

Two PHP calls: one with just the chart key, another with bookWholeTables='chart' and version='draft'.

```php
$seatsioClient->chartReports->summaryByCategoryKey("chartKey");  

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

```

--------------------------------

### Ruby: with_season_bookings_not_propagated and by_availability_reason

Source: https://docs.seats.io/docs/api/events-reports/flat

Ruby example using the seatsio client to get event reports without propagated season bookings.

```ruby
without_propagation = @seatsio.event_reports.with_season_bookings_not_propagated  

without_propagation.by_availability_reason("season34")  

without_propagation.by_availability_reason("season34", "available")  

without_propagation.by_availability_reason("eventInSeason34", "booked")  

```

--------------------------------

### Python client authentication examples

Source: https://docs.seats.io/docs/api/authentication

Shows three Python client initialization patterns: workspace secret key, company admin key, and admin key with workspace public key for both call types.

```python
import seatsio  

  

# for calls within a workspace (e.g. booking a seat)  

client = seatsio.Client(seatsio.Region.EU(), secret_key="my-workspace-secret-key")   

  

# for calls not specific to a workspace (e.g. listing all workspaces)  

client = seatsio.Client(seatsio.Region.EU(), secret_key="my-company-admin-key")   

  

# for calls within a workspace (e.g. booking a seat)  

# AND calls not specific to a workspace (e.g. listing all workspaces)  

client = seatsio.Client(seatsio.Region.EU(), secret_key="my-company-admin-key", workspace_key="my-workspace-public-key")   


```

--------------------------------

### Python: with_season_bookings_not_propagated() and by_availability_reason()

Source: https://docs.seats.io/docs/api/events-reports/flat

Python example using the seatsio client to get event reports without propagated season bookings.

```python
without_propagation = self.client.events.reports.with_season_bookings_not_propagated()  

without_propagation.by_availability_reason("season34")  

without_propagation.by_availability_reason("season34", status="available")  

without_propagation.by_availability_reason("eventInSeason34", status="booked")  

```

--------------------------------

### Go: create events in season

Source: https://docs.seats.io/docs/api/create-events-in-season

Go client examples. First creates events with event keys, second creates a number of events.

```go
events, err := client.Seasons.CreateEventsWithEventKeys(season.Key, "event1", "event2")

events, err := client.Seasons.CreateNumberOfEvents("aSeason", 2)
```

--------------------------------

### Java: withSeasonBookingsNotPropagated() and byAvailabilityReason()

Source: https://docs.seats.io/docs/api/events-reports/flat

Java example using the seatsio client to get event reports without propagated season bookings.

```java
EventReports withoutPropagation = client.eventReports.withSeasonBookingsNotPropagated();  

withoutPropagation.byAvailabilityReason("season34");  

withoutPropagation.byAvailabilityReason("season34", "available");  

withoutPropagation.byAvailabilityReason("eventInSeason34", "booked");  

```

--------------------------------

### Create workspace in Go

Source: https://docs.seats.io/docs/api/workspaces-create

Creates a test or production workspace using the Go client. Requires authentication with a company admin key or sandbox admin key.

```go
workspace, err := client.Workspaces.CreateTestWorkspace("a workspace")  

workspace, err := client.Workspaces.CreateProductionWorkspace("a workspace")  
```

--------------------------------

### C#: WithSeasonBookingsNotPropagated() and ByAvailabilityReasonAsync()

Source: https://docs.seats.io/docs/api/events-reports/flat

C# example using the seatsio client to get event reports without propagated season bookings.

```csharp
var withoutPropagation = Client.EventReports.WithSeasonBookingsNotPropagated();  

await withoutPropagation.ByAvailabilityReasonAsync("season34");  

await withoutPropagation.ByAvailabilityReasonAsync("season34", "available");  

await withoutPropagation.ByAvailabilityReasonAsync("eventInSeason34", "booked");  

```

--------------------------------

### Python: create a season with various options

Source: https://docs.seats.io/docs/api/create-season

Shows how to create a season using the Python client. Includes examples for basic creation, custom key, number of events, event keys, and custom table booking config.

```python
client.seasons.create("749b9650-24fb-11e7-93ae-92361f002671") # chart key

client.seasons.create("749b9650-24fb-11e7-93ae-92361f002671", key="aSeasonKey")

client.seasons.create("749b9650-24fb-11e7-93ae-92361f002671", number_of_events=2)

client.seasons.create("749b9650-24fb-11e7-93ae-92361f002671", event_keys=["event1", "event2"])

client.seasons.create("749b9650-24fb-11e7-93ae-92361f002671", table_booking_config=TableBookingConfig.custom({"T1": "BY_TABLE", "T2": "BY_SEAT"}))
```

--------------------------------

### PHP: withSeasonBookingsNotPropagated() and byAvailabilityReason()

Source: https://docs.seats.io/docs/api/events-reports/flat

PHP example using the seatsio client to get event reports without propagated season bookings.

```php
$withoutPropagation = $this->seatsioClient->eventReports->withSeasonBookingsNotPropagated();  

$withoutPropagation->byAvailabilityReason("season34");  

$withoutPropagation->byAvailabilityReason("season34", "available");  

$withoutPropagation->byAvailabilityReason("eventInSeason34", "booked");  

```

--------------------------------

### GET /reports/events/{eventKey}/byAvailabilityReason with seasonBookingsPropagated=false

Source: https://docs.seats.io/docs/api/events-reports/flat

Example URL for limiting season report scope to only objects booked at the season level.

```http
GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byAvailabilityReason?seasonBookingsPropagated=false  

```

--------------------------------

### Ruby client authentication examples

Source: https://docs.seats.io/docs/api/authentication

Shows three Ruby client initialization patterns: workspace secret key, company admin key, and admin key with workspace public key for both call types.

```ruby
require 'seatsio'  

  

# for calls within a workspace (e.g. booking a seat)  

client = Seatsio::Client.new(Seatsio::Region.EU(), "my-workspace-secret-key")  

  

# for calls not specific to a workspace (e.g. listing all workspaces)  

client = Seatsio::Client.new(Seatsio::Region.EU(), "my-company-admin-key")  

  

# for calls within a workspace (e.g. booking a seat)  

# AND calls not specific to a workspace (e.g. listing all workspaces)  

client = Seatsio::Client.new(Seatsio::Region.EU(), "my-company-admin-key", "my-workspace-public-key")  


```

--------------------------------

### C# client authentication examples

Source: https://docs.seats.io/docs/api/authentication

Shows three C# client initialization patterns: workspace secret key, company/sandbox admin key, and admin key with workspace public key for both call types.

```csharp
using SeatsioDotNet;  

  

// for calls within a workspace (e.g. booking a seat)  

var client = new SeatsioClient(Region.EU, "<WORKSPACE SECRET KEY>");  

  

// for calls not specific to a workspace (e.g. listing all workspaces)  

var client = new SeatsioClient(Region.EU, "<COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>");  

  

// for calls within a workspace (e.g. booking a seat)  

// AND calls not specific to a workspace (e.g. listing all workspaces)  

var client = new SeatsioClient(Region.EU, "<COMPANY ADMIN KEY OR SANDBOX ADMIN KEY>", "<WORKSPACE PUBLIC KEY>");  


```

--------------------------------

### GET /reports/events/{eventKey}/byStatus/summary/deep

Source: https://docs.seats.io/docs/api/events-reports/deep-summary

HTTP endpoint for retrieving a deep summary report by status for an event. Includes the request URL, parameters, and example response.

```APIDOC
## [GET] /reports/events/{eventKey}/byStatus/summary/deep

### Description
Retrieves a deep summary report of an event, grouped by the status of the objects. The report provides counts and breakdowns by section, channel, category key, category label, availability, and object type.

### Method
GET

### Endpoint
`https://api-{region}.seatsio.net/reports/events/{eventKey}/byStatus/summary/deep`

### Parameters
#### Path Parameters
- **eventKey** (string) - Required - The key of the event.

#### Query Parameters
- **seasonBookingsPropagated** (boolean) - Optional - Whether bookings made through a season should be propagated down to this event when computing the report.

### Request Example
```
curl https://api-{region}.seatsio.net/reports/events/event34/byStatus/summary/deep -u aSecretKey:
```

### Response
#### Success Response (200)
- **booked** (object) - Contains the count and breakdowns for objects with status `booked`.
  - **count** (integer) - The total number of objects with this status.
  - **bySection** (object) - Breakdown by section. Each key is a section name (e.g., `NO_SECTION`), and the value contains the count and further breakdowns.
    - **count** (integer) - The count for this section.
    - **byChannel** (object) - Breakdown by channel. Each key is a channel name (e.g., `NO_CHANNEL`, `channel1`), and the value is the count.
    - **byCategoryKey** (object) - Breakdown by category key. Each key is a category key (e.g., `1`, `3`), and the value is the count.
    - **byAvailability** (object) - Breakdown by availability. Each key is an availability value (e.g., `not_selectable`), and the value is the count.
    - **byCategoryLabel** (object) - Breakdown by category label. Each key is a category label (e.g., `cat1`, `cat3`), and the value is the count.
    - **byObjectType** (object) - Breakdown by object type. The structure is not fully shown in the example.
  - **byChannel** (object) - Breakdown by channel. Each key is a channel name, and the value contains the count and further breakdowns.
    - **count** (integer) - The count for this channel.
    - **bySection** (object) - Breakdown by section. Each key is a section name, and the value is the count.
    - **byCategoryKey** (object) - Breakdown by category key. Each key is a category key, and the value is the count.
    - **byAvailability** (object) - Breakdown by availability. Each key is an availability value, and the value is the count.
    - **byCategoryLabel** (object) - Breakdown by category label. Each key is a category label, and the value is the count.
    - **byObjectType** (object) - Breakdown by object type. The structure is not fully shown in the example.
  - **byCategoryKey** (object) - Breakdown by category key. The structure is not fully shown in the example.
  - **byAvailability** (object) - Breakdown by availability. The structure is not fully shown in the example.
  - **byCategoryLabel** (object) - Breakdown by category label. The structure is not fully shown in the example.
  - **byObjectType** (object) - Breakdown by object type. The structure is not fully shown in the example.
- **free** (object) - Contains the count and breakdowns for objects with status `free`. The structure is the same as for `booked`.

#### Response Example
```json
{
  "booked": {
    "count": 9,
    "bySection": {
      "NO_SECTION": {
        "count": 9,
        "byChannel": {
          "NO_CHANNEL": 7,
          "channel1": 2
        },
        "byCategoryKey": {
          "1": 2,
          "3": 7
        },
        "byAvailability": {
          "not_selectable": 9
        },
        "byCategoryLabel": {
          "cat3": 7,
          "cat1": 2
        },
        "byObjectType": {
          ...
        }
      }
    },
    "byChannel": {
      "NO_CHANNEL": {
        "bySection": {
          "NO_SECTION": 7
        },
        "count": 7,
        "byCategoryKey": {
          "3": 7
        },
        "byAvailability": {
          "not_selectable": 7
        },
        "byCategoryLabel": {
          "cat3": 7
        },
        "byObjectType": {
          ...
        }
      },
      "channel1": {
        "bySection": {
          "NO_SECTION": 2
        },
        "count": 2,
        "byCategoryKey": {
          "1": 2
        },
        "byAvailability": {
          "not_selectable": 2
        },
        "byCategoryLabel": {
          "cat1": 2
        },
        "byObjectType": {
          ...
        }
      }
    },
    "byCategoryKey": {
      ...
    },
    "byAvailability": {
      ...
    },
    "byCategoryLabel": {
      ...
    },
    "byObjectType": {
      ...
    }
  },
  "free": {
    ...
  }
}
```
```

--------------------------------

### C# CreatePartialSeasonAsync examples

Source: https://docs.seats.io/docs/api/create-partial-season

C# examples for creating a partial season asynchronously. The first call uses the default key, the second specifies a partial season key, and the third adds event keys.

```csharp
await Client.Seasons.CreatePartialSeasonAsync("aTopLevelSeason");  

await Client.Seasons.CreatePartialSeasonAsync("aTopLevelSeason", partialSeasonKey: "aPartialSeason");  

await Client.Seasons.CreatePartialSeasonAsync("aTopLevelSeason", eventKeys: new[] {"event1", "event2"});  
```

--------------------------------

### GET /charts (with workspace)

Source: https://docs.seats.io/docs/api/authentication

Example of a raw HTTP call to the charts endpoint using a company admin key or sandbox admin key with a workspace specified.

```APIDOC
## [GET] /charts (with workspace)

### Description
Retrieves a list of charts for a specific workspace when using a company admin key or sandbox admin key. The workspace is specified via the X-Workspace-Key header.

### Method
GET

### Endpoint
https://api-{region}.seatsio.net/charts

### Parameters
#### Headers
- **Authorization** (string) - Required - Basic authentication header. Format: `Basic <base64(secretKey:)>`.
- **X-Workspace-Key** (string) - Required - Public workspace key to specify the workspace.

### Request Example
```
curl -u 550e8400-e29b-41d4-a716-446655440000: -H "X-Workspace-Key: c49fe901-c35b-4d5a-a0cf-2b4c6124738b" https://api-{region}.seatsio.net/charts
```

### Response
#### Success Response (200)
Returns a list of charts for the specified workspace. The response body is not specified in the source.

#### Response Example
Not provided in the source.
```

--------------------------------

### Python create_partial_season examples

Source: https://docs.seats.io/docs/api/create-partial-season

Python examples for creating a partial season. The first call uses the default key, the second specifies a partial season key, and the third adds event keys.

```python
client.seasons.create_partial_season("aTopLevelSeason")  

client.seasons.create_partial_season("aTopLevelSeason", partial_season_key="aPartialSeason")  

client.seasons.create_partial_season("aTopLevelSeason", event_keys=["event1", "event2"])  
```

--------------------------------

### C#: Remove ticket buyer IDs

Source: https://docs.seats.io/docs/api/remove-ticket-buyer-ids

C# example using the Seatsio client to remove ticket buyer IDs. Generates three GUIDs and passes them as an array to RemoveAsync.

```csharp
var ticketBuyerId1 = Guid.NewGuid();
var ticketBuyerId2 = Guid.NewGuid();
var ticketBuyerId3 = Guid.NewGuid();
var response = await Client.TicketBuyers.RemoveAsync(new[] {ticketBuyerId1, ticketBuyerId2, ticketBuyerId3});
```

--------------------------------

### JSON: List charts response

Source: https://docs.seats.io/docs/api/list-all-charts

Example response from the GET /charts endpoint. Shows pagination via next_page_starts_after and chart objects with fields like name, id, key, status, tags, archived, and thumbnail URLs.

```json
{  
    "next_page_starts_after": 12,  
    "items": [  
        {  
            "name":"chart1",  
            "id":"20",  
            "key":"6451436c-24fb-11e7-93ae-92361f002671",  
            "status":"PUBLISHED",  
            "tags": [],  
            "archived": false,  
            "publishedVersionThumbnailUrl": "https://thumbnails.seats.io/workspaceKey/.../published/.../thumbnail"  
        },  
        {  
            "name":"chart2",  
            "id":"19",  
            "key":"749b9650-24fb-11e7-93ae-92361f002671",  
            "status":"PUBLISHED_WITH_DRAFT",  
            "tags": ["tag1", "tag2"],  
            "archived": false,  
            "publishedVersionThumbnailUrl": "https://thumbnails.seats.io/workspaceKey/.../published/.../thumbnail",  
            "draftVersionThumbnailUrl": "https://thumbnails.seats.io/workspaceKey/.../draft/.../thumbnail"  
        }  
    ]  
}  
```

--------------------------------

### Ruby client example for summary_by_category_key

Source: https://docs.seats.io/docs/api/chart-reports/summary

Two Ruby calls: one with just the chart key, another with bookWholeTables='chart' and version='draft'.

```ruby
client.chart_reports.summary_by_category_key("chartKey")  

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

```

--------------------------------

### Ruby create_partial_season examples

Source: https://docs.seats.io/docs/api/create-partial-season

Ruby examples for creating a partial season. The first call uses the default key, the second specifies a partial season key, and the third adds event keys.

```ruby
client.seasons.create_partial_season key: "aTopLevelSeason"  

client.seasons.create_partial_season key: "aTopLevelSeason", partial_season_key: 'aPartialSeason'  

client.seasons.create_partial_season key: "aTopLevelSeason", event_keys: ['event1', 'event2']  
```

--------------------------------

### cURL: GET /charts request

Source: https://docs.seats.io/docs/api/list-all-charts

Example curl command to list charts. Replace {region} with the appropriate region (europe, na, oc, sa) and use your workspace secret key. The maximum number of charts returned per request is 20.

```bash
curl https://api-{region}.seatsio.net/charts -u aSecretKey:   
```

--------------------------------

### GET byZone report endpoints

Source: https://docs.seats.io/docs/api/events-reports/detail

HTTP GET endpoints for the byZone report. Use the first to get all zones, the second to filter by a specific zone, and the third to get objects without a zone.

```http
GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byZone  

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byZone/{zone}  

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byZone/NO_ZONE  
```
Tokens:
Raw