Skip to main content

Regions

Regions detects a user's country, state, DMA (media market), or postal code.

Regions provides the following user context:

{
country: {
code: "US",
name: "United States",
flag: "🇺🇸"
},
state: {
code: "MD",
name: "Maryland"
},
dma: {
code: "26",
name: "Baltimore"
},
postalCode: {
code: "21014"
}
}

Regions also provides the following events:

  • user.entered_region_country
  • user.exited_region_country
  • user.entered_region_state
  • user.exited_region_state
  • user.entered_region_dma
  • user.exited_region_dma
  • user.entered_region_postal_code
  • user.exited_region_postal_code

Regions is available on the Team plan and higher.

Countries#

Regions supports country detection globally. Each country has a name and a unique 2-letter ISO 3166 code. View the full list of countries.

Country whitelist or blacklist#

Regions can also be used to whitelist or blacklist location updates in specific countries for privacy or compliance reasons. Contact your customer success manager to enable this feature.

States#

Regions supports state detection in the US only. Each state has a name and a unique 2-letter code. View the full list of states.

DMAs#

Regions supports DMA (designated market area) detection in the US only. Each DMA has a name and a unique code. View the full list of DMAs. Or, learn more about DMAs.

Postal codes#

Regions supports postal (ZIP) code detection in the US only. Each postal code has a unique 5-letter code.