Help Center

Menu

Edge Side Includes (ESI)

In designs and pages, you can add Edge Side Includes (ESIs) using the <esi:vars> element.

The GeoIP ESI variables listed on this page might not be available in all Squiz DXP environments.

How third-party proxies or Content Delivery Networks (CDNs) interact with the GEOIP vars exposed through the Squiz DXP environment impacts their availability.

Before implementing an ESI strategy for your site, ask Squiz Support to verify if any third-party proxy or CDN services will affect your GEOIP rules.

GeoIP ESI variables

Single ESI variable property
<esi:vars>$(GEOIP_COLO)</esi:vars>

You can specify multiple properties in a single <esi:vars> element.

Multiple ESI variable properties
<esi:vars>$(GEOIP_COLO),$(GEOIP_REGION)</esi:vars>
GEOIP_COLO

Retrieves the three-letter IATA airport code for the closest server.
For example, SYD.

GEOIP_CONTINENT

Retrieves the two-letter continent code of the incoming request.
For example, NA, EU, or OC.

GEOIP_CITY

Retrieves the city of the incoming request.
For example, Sydney.

GEOIP_COUNTRY

Retrieves the two-letter country of the incoming request.
For example: US, FR or NZ.

GEOIP_LATITUDE

Retrieves the latitudinal coordinates of the incoming request.
For example: -27.46790.

GEOIP_METROCODE

Retrieves the Google AdWords metro code matching the GEOIP_CITY returned.
For example, 635 for Austin, Texas.

Google AdWords Metro Codes match Nielsen Media Research Designated Market Area (DMA) broadcasting market codes for United States metropolitan areas. Read the Wikipedia article on Media markets for conceptual information and a diagram showing the market areas in the United States.
GEOIP_POSTALCODE

Retrieves the regional postal code for the GEOIP_CITY.
For example, 2000.

GEOIP_REGION

Retrieves the ISO 3166-2 first-level region name for the GEOIP_CITY.
For example, New South Wales

GEOIP_REGIONCODE

Retrieves the ISO 3166-2 principal subdivision code for the GEOIP_CITY.
For example, NSW.

GEOIP_TIMEZONE

Retrieves the timezone region information in the format <Country>/<Region>.
For example, Australia/Sydney.