Insights

The insights operation retrieves metadata about the lead event that generated a TrustedForm certificate. The properties included in the response can be used to filter and/or route your leads to optimize your business strategies. More information is available in our knowledge base.

Important: Requires a Professional plan or higher. The effective unit cost for an insights call depends on the Insights data points retrieved.

InsightsParameters

Request individual Insights data points (`properties`) to be returned
and terms for which to scan for in a certificate session replay.
properties
required
Array of strings
    A list of the Insights data points you would like to be returned in
    the response. Some `properties` are not

    compatible with all certificate types and will return a null value.
    Only contracted `properties` are

    available to query. Your account will only be charged for properties
    that are returned.

    See InsightsResult for `form_input_method` values.
Items Enum: Description
age_seconds

The number of seconds elapsed since the last recorded session replay event

approx_ip_geo

The consumer's approximate geographical location based on ip

bot_detected

A determination of whether the events documented were likely produced by a non-human entity based on ActiveProspect’s proprietary algorithms. This data point is currently undergoing alpha testing. It may contain flaws and may be discontinued.

browser

An object containing properties that provide information about the consumer's browser.

created_at

The UTC ISO8601 formatted date and time when TrustedForm Certify was loaded.

domain

The domain shown to the consumer during the lead event

expires_at

The UTC ISO8601 formatted date and time when the certificate will expire.

form_input_kpm

The average number of keystrokes per minute based on the consumer's rate of form input.

form_input_method

Methods used by the consumer to fill web form fields

form_input_wpm

The approximate number of words per minute calculated by using the form_input_kpm and assuming five characters represent a word.

ip

The consumer's public IP address

is_framed

A boolean indicating that the form was displayed within an iframe.

is_masked

A boolean indicating if the certificate is masked and does not show source information nor a session replay.

num_sensitive_content_elements

Count of how many content elements (e.g. img, div) are marked sensitive and hidden from the session replay.

num_sensitive_form_elements

Count of how many form elements (e.g. input, textarea) are marked sensitive and hidden from the session replay.

os

An object containing properties that provide information about the consumer's operating system.

page_url

The URL of the page hosting TrustedForm Certify.

parent_page_url

The parent URL of the page hosting TrustedForm Certify, if framed.

seconds_on_page

The time in seconds between when TrustedForm Certify was loaded and when the most recent cert event was received.

object

An object containing the terms to use to perform a page scan which checks for their presence in the content captured by the certificate.

{
  • "properties": [
    • "seconds_on_page",
    • "domain",
    • "bot_detected",
    • "ip",
    • "approx_ip_geo",
    • "browser",
    • "age_seconds",
    • "created_at",
    • "expires_at",
    • "form_input_method",
    • "form_input_kpm",
    • "form_input_wpm",
    • "is_framed",
    • "is_masked",
    • "num_sensitive_content_elements",
    • "num_sensitive_form_elements",
    • "page_url",
    • "parent_page_url",
    • "os"
    ],
  • "scans": {
    • "forbidden": [
      • "free",
      • "ipad"
      ],
    • "required": [
      • "home security system"
      ]
    }
}

InsightsResult

One of:
object

The data points requested, if available.

object (ScansResult)

An object containing the properties that are part of the page scan process.

{
  • "properties": {
    • "age_seconds": 76287,
    • "approx_ip_geo": {
      • "city": "Dallas",
      • "country_code": "US",
      • "lat": 32.7451,
      • "lon": -96.8038,
      • "postal_code": "75203",
      • "state": "Texas",
      • "time_zone": "America/Chicago"
      },
    • "bot_detected": false,
    • "browser": {
      • "full": "Chrome 128.0.0.0",
      • "name": "Chrome",
      • "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36",
      • "version": {
        • "full": "128.0.0.0",
        • "major": "128",
        • "minor": "0",
        • "patch": "0"
        }
      },
    • "created_at": "2024-09-18T17:07:09Z",
    • "domain": "example.com",
    • "expires_at": "2024-12-20T17:07:09Z",
    • "form_input_kpm": 234.92560689115115,
    • "form_input_method": [
      • "typing"
      ],
    • "form_input_wpm": 47.355958958168905,
    • "ip": "192.168.0.1",
    • "is_framed": false,
    • "is_masked": false,
    • "num_sensitive_content_elements": 0,
    • "num_sensitive_form_elements": 0,
    • "os": {
      • "full": "Mac OS X 10.15.7",
      • "is_mobile": false,
      • "name": "Mac OS X",
      • "version": {
        • "full": "10.15.7",
        • "major": "10",
        • "minor": "15",
        • "patch": "7"
        }
      },
    • "page_url": "https://www.example.com/contact.html",
    • "parent_page_url": null,
    • "seconds_on_page": 1129
    },
  • "scans": {
    • "forbidden": [
      • "free"
      ],
    • "required": [
      • "offer"
      ],
    • "result": {
      • "forbidden": {
        • "found": [ ],
        • "not_found": [
          • "free"
          ]
        },
      • "required": {
        • "found": [ ],
        • "not_found": [
          • "offer"
          ]
        },
      • "success": false
      }
    }
}