API Reference

API Reference

Map Views API

On this page we'll explore the map views API that let you programmatically manage the map views for your account.

Each map can have one or more map views, with each map view being a unique version of a map (ie. with its own content or styling).

ENDPOINTS

GET /map-views/v1/:map_id
POST /map-views/v1/:map_id
GET /map-views/v1/:map_id/:id
PUT /map-views/v1/:map_id/:id
DELETE /map-views/v1/:id
POST /map-views/v1/:map_id/:id/publish

The Map View object

Properties

Name
map_view_id
Type
string
Description
Unique identifier for the map view.
Name
map_id
Type
string
Description
The ID of the Map that the map view belongs to.
Name
name
Type
string
Description
The name of the map view.
Name
state
Type
string
Description
The state of the map view. Can be pending, processing, live, not_live or error.
Name
tileset_ids
Type
array
Description
The IDs of the Tilesets that the map view uses.
Name
style_id
Type
string
Description
The ID of the Style that the map view uses.
Name
placement_hierarchy_root_nodes
Type
array
Description
The IDs of the Placement Hierarchy Root Nodes that the map view uses.
Name
suggested_search_terms
Type
array
Description
The suggested search terms for the map view.
The suggested search terms are the data source for the buttons that appear (by default) under the search bar when viewing a map view. By changing the suggested search terms in this array, or by reordering the array, you can change the buttons that appear under the search bar.
Name
created_at
Type
timestamp
Description
The timestamp of when the API key was created.
Name
updated_at
Type
timestamp
Description
The timestamp of when the API key was last updated.

The Map View object

{
  "map_view_id": "hSIhXBhNe8X1d8Et",
  "map_id": "hSIhXBhNe8X1d8Et",
  "name": "Exhibitor 1",
  "state": "live",
  "tileset_ids": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "style_id": "hSIhXBhNe8X1d8Et",
  "placement_hierarchy_root_nodes": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "suggested_search_terms": ["Restrooms", "Food", "Exhibitors"],
  "created_at": 692233200,
  "updated_at": 705103200
}

POST/map-views/v1/:map_id

Create a map view

Optional attributes

Name
name
Type
string
Description
The name of the map view.
Name
suggested_search_terms
Type
array
Description
The suggested search terms for the map view. Defaults to an empty array if not provided.

POST /map-views/v1/:map_id

API KEY SCOPE

map-views:write

curl https://api.waygomaps.com/map-views/v1/hSIhXBhNe8X1d8Et \
    -X POST \
    -H "Waygo-API-Key: eyJhbGciOiJIU...sXSJE_1AJgMEnI_g-WTerk" \
    -H "Waygo-Account: n33f9h0fh9324hf9h439fh9h2f9h93h9" \
    -d '{
      "name": "Attendee Map - Comic Con San Diego 2025",
      "suggested_search_terms": ["Restrooms", "Food", "Exhibitors"]
    }'

Response

{
  "map_view_id": "hSIhXBhNe8X1d8Et",
  "map_id": "hSIhXBhNe8X1d8Et",
  "name": "Attendee Map - Comic Con San Diego 2025",
  "state": "live",
  "tileset_ids": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "style_id": "hSIhXBhNe8X1d8Et",
  "placement_hierarchy_root_nodes": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "suggested_search_terms": ["Restrooms", "Food", "Exhibitors"],
  "created_at": 692233200,
  "updated_at": 705103200
}

GET/map-views/v1/:map_id/:id

Retrieve a map view

This endpoint allows you to retrieve a map view by providing its map view ID.

GET /map-views/v1/:map_id/:id

API KEY SCOPE

map-views:read

curl https://api.waygomaps.com/map-views/v1/hSIhXBhNe8X1d8Et/hSIhXBhNe8X1d8Et \
  -H "Waygo-API-Key: eyJhbGciOiJIU...sXSJE_1AJgMEnI_g-WTerk" \
  -H "Waygo-Account: n33f9h0fh9324hf9h439fh9h2f9h93h9"

Response

{
  "map_view_id": "hSIhXBhNe8X1d8Et",
  "map_id": "hSIhXBhNe8X1d8Et",
  "name": "Attendee Map - Comic Con San Diego 2025",
  "state": "live",
  "tileset_ids": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "style_id": "hSIhXBhNe8X1d8Et",
  "placement_hierarchy_root_nodes": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "suggested_search_terms": ["Restrooms", "Food", "Exhibitors"],
  "created_at": 692233200,
  "updated_at": 705103200
}

PUT/map-views/v1/:map_id/:id

Update a map view

This endpoint allows you to perform an update on a map view.

Only the attributes included in the request will be updated in the map view, ie. whichever attributes are not included in the request will not be changed.

Optional attributes

Name
name
Type
string
Description
The name of the map view.
Name
suggested_search_terms
Type
array
Description
The key of the title in the data object.
Name
style_id
Type
string
Description
The ID of the Style that the map view uses.

PUT /map-views/v1/:map_id/:id

API KEY SCOPE

map-views:write

curl -X PUT https://api.waygomaps.com/map-views/v1/hSIhXBhNe8X1d8Et/hSIhXBhNe8X1d8Et \
  -H "Waygo-API-Key: eyJhbGciOiJIU...sXSJE_1AJgMEnI_g-WTerk" \
  -H "Waygo-Account: n39q9h0ph9324hf9h4vksh9h2f9h03hl" \
  -d '{
    "name": "Attendee Map - Comic Con San Diego 2025",
    "suggested_search_terms": ["Restrooms", "Food", "Exhibitors"]
  }'

Response

{
  "content_id": "hSIhXBhNe8X1d8Et",
  "catalog_id": "hSIhXBhNe8X1d8Et",
  "name": "Attendee Map - Comic Con San Diego 2025",
  "state": "live",
  "tileset_ids": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "style_id": "hSIhXBhNe8X1d8Et",
  "placement_hierarchy_root_nodes": ["hSIhXBhNe8X1d8Et", "hSIhXBhNe8X1d8Et"],
  "suggested_search_terms": ["Restrooms", "Food", "Exhibitors"],
  "created_at": 692233200,
  "updated_at": 705103200
}

DELETE/map-views/v1/:id

Delete a map view

This endpoint allows you to delete a map view from your account.

Be extremely cautious using this endpoint on any map view.

DELETE /map-views/v1/:id

API KEY SCOPE

map-views:delete

curl -X DELETE https://api.waygomaps.com/map-views/v1/hSIhXBhNe8X1d8Et \
  -H "Waygo-API-Key: eyJhbGciOiJIU...sXSJE_1AJgMEnI_g-WTerk" \
  -H "Waygo-Account: n33f9h0fh9324hf9h439fh9h2f9h93h9"

POST/map-views/v1/:map_id/:id/publish

Publish a map view tileset

This endpoint allows you to publish a map view's tileset. When you make updates to the Content placed on a map view, you must call this endpoint to ensure that the map view's tileset gets updated with the new Content.

This endpoint will only work if the map view is in the live state.

POST /map-views/v1/:map_id/:id/publish

API KEY SCOPE

map-views:write

curl https://api.waygomaps.com/map-views/v1/hSIhXBhNe8X1d8Et/hSIhXBhNe8X1d8Et/publish \
    -X POST \
    -H "Waygo-API-Key: eyJhbGciOiJIU...sXSJE_1AJgMEnI_g-WTerk" \
    -H "Waygo-Account: n33f9h0fh9324hf9h439fh9h2f9h93h9"