Each identified visitor IP uses reveal credits on your plan. See Credits and Usage.
Enable Spotter
Once Spotter is enabled for your account, it’s still off for each tracking script until you turn it on. To do that, setspotter_enabled and make sure the script has at least one domain. You can do both when you create a script or on an existing one:
spotter_enabled to false to turn Spotter off again. The script keeps its domains.
If Spotter isn’t enabled for your account, turning it on returns a 422. Scripts keep their spotter_enabled value if Spotter is later turned off for your account, but browser calls are refused until it’s back on.
Which Domains Can Call Spotter
Spotter uses the samedomains list as event ingestion:
Get the Identification
CallgetSpotterIdentification() once the tracker has loaded. It isn’t available before then, so call it from an initialized listener added right after the loader script:
Response
When There Is No Result
getSpotterIdentification() resolves to undefined and logs a warning to the console when:
- The visitor can’t be matched to a company
- Spotter is off for this script or for your account
- The page isn’t on one of the script’s domains
- Your reveal credits have run out
Credits and Usage
Each successful identification is logged as a reveal:- You pay one credit per visitor IP, per tracking script, per monthly window. Repeat calls for the same IP in that window don’t cost more.
- Spotter shares this count with the IP to Company API and with webhook reveals, so an IP revealed through more than one of them still costs one credit.
- Visitors Spotter can’t identify don’t cost a credit.
- Once your reveal credits run out, Spotter stops returning identifications.
GET /radar/operator/v1/company/usage. revealUsage is what you’re billed for. apiUsage and spotterUsage split it by where the reveal came from. An IP revealed through both counts in each, so the two can add up to more than revealUsage.
Spotter only runs when a page asks for it: when it calls
getSpotterIdentification(), or when it has a window.SpotterSettings.callback set before the loader script.Using Your Own Proxy
Spotter requests go through the API host in your loader script, and rely on two things reaching Radar:- The
Originheader, to check the domain. Without it, the request is refused. - The visitor’s IP address, to identify the company.