SettingsSet edge IP/geo enrichment

Set edge IP/geo enrichment

Turn edge IP/geo stamping on or off. Requires an agency key (ak_) and ?location_id=; viewer keys get 403 agency_required.

When on, the ingest worker adds $ip, $geo_country, $geo_region, $geo_region_code, $geo_city and $geo_postal from Cloudflare's edge data for the request. Three reasons to prefer it over the browser's own lookup: it cannot be spoofed by the client, it costs the visitor no round trip, and it is present on the first event of a visit — the SDK's own lookup never blocks a capture, so an early event would otherwise carry no geo.

Properties already on the event win, so an SDK-supplied $geo_* or an explicit $ip is never overwritten. Cloudflare's unknown/Tor sentinels (XX, T1) are skipped rather than stored, because they cannot match a real person and only degrade Meta's match quality.

This is also where match rate comes from for server-side conversions: the values feed Meta CAPI client_ip_address and the hashed ct/st/zp/country keys.

Off by default, and never applied to HIPAA tenants — IP and geo are identifying.

curl -X PUT "https://mythic-analytics.gulp.workers.dev/client/v1/settings/ip-geo-enrichment" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "ip_geo_enrichment": true
}'
{
  "success": true,
  "data": {
    "ip_geo_enrichment": true,
    "effective": {
      "enabled": true,
      "blocked_by_hipaa": true
    }
  }
}
PUT
/ip-geo-enrichment
PUT
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.

Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.
Content-Typestring
Required

The media type of the request body

Options: application/json
ip_geo_enrichmentboolean
Required

Whether the ingest edge stamps $ip and $geo_* on every event.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.

Body

application/json
ip_geo_enrichmentboolean
Required

Whether the ingest edge stamps $ip and $geo_* on every event.

Responses

successboolean
dataobject