Skip to main content

List all charts

Returns a paginated list of charts you’ve previously created in a workspace. The charts are returned in reverse chronological order: the most recently created charts will appear first in the list.

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

GET https://api-{region}.seatsio.net/charts?filter=london
GET https://api-{region}.seatsio.net/charts?tag=WestEnd
GET https://api-{region}.seatsio.net/charts?validation=true
GET https://api-{region}.seatsio.net/charts?expand=events

More info: https://docs.seats.io/docs/api-pagination
Note

The maximum number of charts that can be retrieved in a single request is 20.

An example​

curl https://api-{region}.seatsio.net/charts -u aSecretKey: 
{
    "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"
        }
    ]
}

The status of a chart can be either

  • "NOT_USED": there are no events linked to the chart
  • "PUBLISHED": there's an event linked to the chart, and there's no draft version
  • "PUBLISHED_WITH_DRAFT": there's an event linked to the chart, and a draft version exists

publishedVersionThumbnailUrl (and draftVersionThumbnailUrl if applicable) are URLs that return a PNG thumbnail for the chart.

Query parameters​

This is a paginated API endpoint, so the normal pagination query params (limit, start_after_id and end_before_id) are applicable. See this page for more info.

  • filter (optional)
    Allows you to filter on chart name (case insensitive). Specifying multiple filters will result in a 400 Bad Request.

  • tag (optional)
    Return only charts that have this tag. Specifying multiple tags will result in a 400 Bad Request.

  • validation (optional)
    Set to true to return validation errors and warnings for the charts (if any).

  • expand (optional) Charts have events associated with them. You can expand the events for each chart by providing expand=events.

  • eventsLimit (optional) The maximum number of events to retrieve per chart, when expand=events is also passed in. Defaults to 100.

// newest charts having 'london' in their name
$seatsioClient->charts->listFirstPage((new ChartListParams())->withFilter('london')); 

// newest charts tagged 'WestEnd'
$seatsioClient->charts->listFirstPage((new ChartListParams())->withTag('WestEnd')); 

// newest charts, together with validation errors and warnings
$seatsioClient->charts->listFirstPage((new ChartListParams())->withValidation(true)); 

// newest charts and a list of linked events
$seatsioClient->charts->listFirstPage((new ChartListParams())->withExpandEvents(true)); 
{
    "items": [
        {
            "name":"chart1",
            "id":"20",
            "key":"6451436c-24fb-11e7-93ae-92361f002671",
            "status":"PUBLISHED",
            "archived": false,
            "publishedVersionThumbnailUrl": "https://thumbnails.seats.io/workspaceKey/.../published/.../thumbnail",
            "events": [
                {
                    "id": "50",
                    "bookWholeTables": false,
                    "key": "eventKey2"
                },
                {
                    "id": "49",
                    "bookWholeTables": false,
                    "key": "event34"
                }
            ],
            "validation": {
              "errors": ["VALIDATE_OBJECTS_WITHOUT_CATEGORIES"],
              "warnings": ["VALIDATE_DUPLICATE_LABELS"]
            }
        },
        {
            "name":"chart2",
            "id":"19",
            "key":"749b9650-24fb-11e7-93ae-92361f002671",
            "status":"NOT_USED",
            "archived": false,
            "publishedVersionThumbnailUrl": "https://thumbnails.seats.io/workspaceKey/.../published/.../thumbnail"
        }
    ]
}