Skip to main content

URL parameters

Parameters can be added to the URL of an ArcGIS StoryMaps item to modify its behavior or activate specific features. They must be added to an ArcGIS StoryMaps URL using the following convention:

[baseURL] + ? + [parameter1] + & + [parameter2] + & + [parameter3] + ...

Base URLs

Base URLs are the server endpoints ArcGIS StoryMaps uses to access resources and functionality. The three base URLs that support parameters are listed below.

Action Base URL
Create a new item https://storymaps.arcgis.com/[item-type]/new
Edit an item (builder) https://storymaps.arcgis.com/[item-type]/[item-ID]/edit
View an item (viewer) https://storymaps.arcgis.com/[item-type]/[item-ID]

Notes:

  • The [item-type] can be stories, briefings, frames, collections, templates, or themes.

  • The [item-ID] is the ID of an ArcGIS item of type StoryMap or StoryMap theme.

  • There is currently no way to view a theme.

Important:

On ArcGIS Enterprise, replace storymaps.arcgis.com with [your-portal-domain]/[web-adaptor-name]. For example, https://www.myorg.gov/my-portal/[item-type]/new.

Display parameters

Display parameters are used with the viewer base URL:

https://storymaps.arcgis.com/[item-type]
Parameter
Behavior Values
Story Briefing Frame Collection
play Activate autoplay true (default)
false		 ✅ ✅ ✅
speed Control autoplay speed (requires play=true) slow
medium (default)
fast		 ✅ ✅ ✅
header Show/hide the header when viewing an item true (default)
false		 ✅ ✅ ✅
cover Show/hide the cover true (default)
false		 ✅ ✅ ✅ ✅
navigation Show/hide navigation controls true (default)
false		 ✅
item Display a collection item by numerical position 1, 2, 3, ... ✅

Notes:

  • The default is used when no value is specified for a parameter. For example, play is the same as play=true.

  • The header and cover URL parameters will override the currently configured behavior of the item. For example, if a story has the Hide cover activated, cover=true can be used to show the cover. For more information, see Configure story settings.

  • The header is hidden when a story is embedded in an <iframe>, but the header parameter can be used to force it to show. The header is not hidden by default for embedded briefings or collections since it contains navigation elements. For more information, see Standard embedding.

  • Hiding the header for a briefing will make its navigation toolbar unavailable. Readers can still navigate using the keyboard or a slide remote. The header cannot be hidden for a collection.

Create item parameters

These parameters are used with the base URL for creating new ArcGIS StoryMaps items:

https://storymaps.arcgis.com/[item-type]/new
Parameter
Behavior Values
Story Briefing Frame Collection
theme Create a new ArcGIS StoryMaps item and apply a theme [theme-item-ID] ✅ ✅ ✅
webmap Create a new ArcGIS StoryMaps item and add a web map as the first block [webmap-item-ID] ✅ ✅
webscene Create a new ArcGIS StoryMaps item and add a web scene as the first block [webscene-item-ID] ✅ ✅
template Create a new ArcGIS StoryMaps item from a template [template-item-ID] ✅

Other parameters

These parameters work with all item types.

Parameter
Behavior Values
urlKey Direct the user to the login page for a particular organization–for example, if an organization uses enterprise logins. Your ArcGIS organization short name, which is the first part of your organization URL. See example below.
Tip:

For more information on using the urlKey parameter, see Sharing a StoryMap with an organization-specific link.

Examples

The examples below combine the base URL and parameters to illustrate how to construct a valid URL for several typical use cases.

Action URL
Enable autoplay at slow speed for a briefing with an ID of abcdef123456 .../briefings/abcdef123456?play&speed=slow
Hide the header for a briefing .../briefings/[item-ID]?header=false
Hide the header and cover for a story .../stories/[item-ID]?header=false&cover=false
Hide the header but show the cover for a story .../stories/[item-ID]?header=false&cover=true
Display the fifth item in a collection .../collections/[item-ID]?item=5
Create a new story with a web map with an ID of abcdef123456 added as the first block .../stories/new?webmap=[abcdef123456]
Direct readers to sign in at https://myorg.maps.arcgis.com .../briefings/[item-ID]?urlKey=myorg

Additional resources

Back to top