▲
URL Search parameters
When you create a URL using the Deploy wizard it contains a number of parameters. Take for example the following URL:
https://viewer.blipstar.com/search?uid=123456&type=nearest&width=autoIt has three parameters defined: uid, type and width. Below is a list of parameters that Blipstar understands. Feel free to experiment, but be aware incorrect values might cause strange results!
Tip: If a parameter is specified in the URL it will override the setting you have in Configure (e.g. if your default search type is Nearest locations but the URL contains a type parameter of radius (&type=state) the State search type will be used.
| Parameter | Name | Description | Value |
|---|---|---|---|
| uid | Unique id | Blipstar account id | Number (REQUIRED) |
| type | Search type | Type of search | nearest, radius, name, regions, all, state, country |
| value | Value | Number of results to show or search Radius | Number |
| search | Search | Search location (e.g. city or postal code) | Text |
| style | Map style | Map background type | street, light, dark, satellite, outdoors |
| width | Locator width | Width of locator | auto (fits to width of container) or Number (pixels) |
| tag | Tags 2 | Limit results to locations that match this list of tags | List (tags, comma-separated) |
| tagshow | Tags to show | List of tags to show (dropdown menu or checkboxes) | List (tags, comma-separated) |
| tag2 | Tags 2 | Limit map to locations that match the list of tags (second tag set) | List (tags, comma-separated) |
| iconkey | Icon key | Limit icons in key/legend to those listed | List (icons, comma-separated) |
| keyword | Keyword | Show keyword search | true, false |
| country | Country | Country of search location (chosen from dropdown menu) | Text (country) |
| countrylist | Country list | List of countries to show in the country dropdown menu | List (countries, comma-separated) |
| sc | Search country | Limit map to locations with this Country value | Text (country) |
| rc | Restrict countries | Limit results to locations with a Country matching this list | List (countries, comma-separated) |
| type2 | Search type 2 | If search type is 'show all locations', the type of search within that | nearest, radius, name, regions, state, country |
| gui | Search interface gui | Show a search interface on results page | true, false |
| key | Key | Display a key/legend of icon types | true, false |
| max | Max results | Maximum number of results to display | Number |
| autolocate | Auto-locate | Force the auto-locate option | true, false |
| units | Distance units | Define map units | miles, km |
| language | Language | Map language | en, fr, de, it, es, pt, nl, el, iw |
| height | Locator height | Height of locator | Number (pixels) |