DocsAPI reference

Discovered fields API

Details an agent noticed visitors giving that nobody asked it to collect. List what it found, accept a field to start capturing it properly, dismiss one, or forget it entirely.

On this page
  1. Endpoints
  2. Authentication
  3. Objects returned

Endpoints#

4 operations, each with its parameters, schemas and an example request on its own page.

Authentication#

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

DiscoveredFieldResponse9 fields
  • contact_countintegerrequired
  • first_seen_atanyrequired
  • idstring (uuid)required
  • labelstringrequired
  • last_seen_atanyrequired
  • observation_countintegerrequired
  • samplesarray of anyrequired
  • slugstringrequired
  • statusstringrequired
Message2 fields
  • messagestringrequired
  • okboolean

    Default: true

Something unclear or missing? Tell us and we’ll fix it.