URL parameters

URL parameters provide a versatile way to dynamically customize the presentation of your Builder map in viewer mode, enabling you to create tailored views for specific audiences without the need to create and manage multiple duplicated maps.

Using URL Parameters

Automatic interaction

When interacting with the viewer mode of a Builder map, any changes made are automatically reflected in the URL. For instance, if you use the Search location bar to find a specific address, the location will automatically be appended to the URL parameter, as shown in this example:

https://clausa.app.carto.com/map/5d942679-411f-4ab7-afb7-0f6061c9af63?search=New+York

Manual addition

You can manually add URL parameters to customize the behavior of your map in viewer mode. To manually include URL parameters, follow these guidelines, along with the parameter table referencer:

  • Use the '&' symbol to separate multiple parameters.

  • The first parameter should start with a '?' symbol.

  • Replace spaces in the URL with plus signs '+'.

  • Utilize encoded formatting, such as %28 and %29 for parentheses or %2C for commas, when needed.

Limit Considerations

  • URL Length: The URL of the map has a limit of 2083 characters. Exceeding this limit may result in the removal of parameters from the URL. Keep your URL within this limit for desired map settings.

  • Time Series Widget: URL parameters do not support the Time Series Widget settings.

  • Parameter Validation: Ensure correct parameter formatting and validity. Invalid or meaningless parameters will be ignored by the map.

  • Edit Mode: Parameters are only accepted when viewing the map either automatically or by manual input. Please note that any additions of parameters in the map URL editor mode will be ignored.

Parameter Reference

Refer to the table below for detailed information about each parameter that can be included in the URL to customize your map.

Last updated