Searching / Global / Suggestions

NameSuggestion
DescriptionProvides multiple suggestions for each entity requested.
TypeGET
URL/v9/searches/suggestions

Long Description

Provides multiple suggestions for each entity requested.  The results will be nested in each entity, and each one will return at most, the limit asked for.  The results for each entity will be ordered by search relevance, and also by popularity score if it exists.

Parameters

Name
Description
Value Type
Required
entities
OR
entities[] 

Either a comma-separated list (preferred) or an array of entities for which you would like to get suggestions or an array of entities (non-preferred). Possible values:

  • brokerages

  • clients

  • events

  • offices

  • performers

  • venues


If you use an array be sure to urlencode the square brackets. e.g.: GET /v9/search?entities%5B%5D=events&entities%5B%5D=performers

String

Required
limitThe limit of results you would like returned for each entity. Default is 10.IntegerOptional
qThe search query for suggestions.StringRequired
fuzzyIf search results are to match any instead of all words passed. Default is false.BooleanOptional

 

Examples

RequestResponse

GET /v9/searches/suggestions?entities=events,performers,venues&limit=5&q=yankee

OR

GET /v9/searches/suggestions?entities%5B%5D=events&entities%5B%5D=performers&entities%5B%5D=venues&limit=5&q=yankee

{
  "suggestions": {
    "performers": [
      {
        "venue_name": null,
        "company": null,
        "slug": "new-york-yankees",
        "id": "15533",
        "occurs_at": null,
        "type": "performers",
        "location": null,
        "name": "New York Yankees"
      },
      {
        "venue_name": null,
        "company": null,
        "slug": "daddy-yankee",
        "id": "2762",
        "occurs_at": null,
        "type": "performers",
        "location": null,
        "name": "Daddy Yankee"
      },
      {
        "venue_name": null,
        "company": null,
        "slug": "tampa-yankees",
        "id": "14841",
        "occurs_at": null,
        "type": "performers",
        "location": null,
        "name": "Tampa Yankees"
      },
      {
        "venue_name": null,
        "company": null,
        "slug": "scranton-wilkes-barre-railriders",
        "id": "14446",
        "occurs_at": null,
        "type": "performers",
        "location": null,
        "name": "Scranton Wilkes-Barre RailRiders"
      },
      {
        "venue_name": null,
        "company": null,
        "slug": "damn-yankees",
        "id": "18097",
        "occurs_at": null,
        "type": "performers",
        "location": null,
        "name": "Damn Yankees"
      }
    ],
    "venues": [
      {
        "venue_name": "Yankee Stadium",
        "company": null,
        "slug": "yankee-stadium",
        "id": "5725",
        "occurs_at": null,
        "type": "venues",
        "location": "Bronx, NY",
        "name": "Yankee Stadium"
      }
    ],
    "events": [
      {
        "venue_name": "Yankee Stadium",
        "company": null,
        "slug": null,
        "id": "527017",
        "occurs_at": "2014-09-06 16:05:00",
        "type": "events",
        "location": "Bronx, NY",
        "name": "Kansas City Royals at New York Yankees"
      },
      {
        "venue_name": "Yankee Stadium",
        "company": null,
        "slug": null,
        "id": "527044",
        "occurs_at": "2014-09-05 19:05:00",
        "type": "events",
        "location": "Bronx, NY",
        "name": "Kansas City Royals at New York Yankees"
      },
      {
        "venue_name": "Yankee Stadium",
        "company": null,
        "slug": null,
        "id": "527035",
        "occurs_at": "2014-09-11 19:05:00",
        "type": "events",
        "location": "Bronx, NY",
        "name": "Tampa Bay Rays at New York Yankees"
      },
      {
        "venue_name": "The Ordway Center for the Performing Arts",
        "company": null,
        "slug": null,
        "id": "609182",
        "occurs_at": "2015-06-16 19:30:00",
        "type": "events",
        "location": "St Paul, MN",
        "name": "Damn Yankees"
      },
      {
        "venue_name": "The Ordway Center for the Performing Arts",
        "company": null,
        "slug": null,
        "id": "609183",
        "occurs_at": "2015-06-17 19:30:00",
        "type": "events",
        "location": "St Paul, MN",
        "name": "Damn Yankees"
      }
    ]
  },
  "total_entries": 11
}