Insights API Operation

Feature Snapshot

Summary:
The Insights API Operation is a TrustedForm feature that retrieves detailed metadata from a TrustedForm certificate, providing real-time, actionable insights into consumer sessions through data such as lead age, browser/OS details, page engagement metrics, and geolocation.

Key Benefits:

• Retrieves a snapshot of technical and behavioral data captured during lead generation
• Enables lead filtering based on nuanced session metrics such as time on page and input method
• Supports rapid troubleshooting and audit processes by returning detailed, structured metadata

Typical Use Cases:

• Evaluating lead quality by analyzing metrics like “age_seconds,” “seconds_on_page,” and user input methods
• Integrating with CRM and lead management systems for automated decision-making based on session data

How the Insights API Operation works

When you invoke the Insights API Operation, you supply a TrustedForm Certificate URL along with a specified set of properties you wish to retrieve (such as lead age, browser type, operating system, domain, IP address, and time on page). The API processes this request and returns a structured JSON response containing the requested metadata, which allows you to assess lead quality and integrate the insights into your lead processing workflow.

Step‑by‑Step Instructions

1. Obtain the TrustedForm Certificate URL from the lead data provided by your vendor or system.
2. Prepare an HTTP POST request including your API key for authentication and set required headers (e.g., “Accept: application/json,” “Content-Type: application/json,” and “api-version: 4.0”) as specified in our API Documentation.
3. Specify the insights operation and properties you wish to retrieve (for example, “age_seconds,” “browser,” “domain,” “ip,” “seconds_on_page,” etc.) in your request body.
4. Send the API request and process the returned JSON response to extract and store the metadata for analysis or integration into your lead management system.

Expected Result:
A JSON response containing detailed metadata fields (such as lead age in seconds, browser details, operating system, IP address, time on page, and form input methods) that provide comprehensive insight into the lead’s session.

Validation & Monitoring (optional)

• Test the Setup: Send a test API request using a known TrustedForm Certificate URL and confirm that the returned JSON includes all specified properties with valid data.
• Where to Monitor?: Monitor API responses in your API client dashboard or review logs, and cross-check historical data in your CRM or analytics dashboard to ensure consistency.

Best Practices

• Securely store the full TrustedForm Certificate URL with each lead record for future correlation and auditing.
• Request only the necessary insight properties in your API call to optimize response size and improve performance.
• Implement automated monitoring and alerting to flag deviations in key metrics like time on page or form input methods.
• Collaborate with compliance and marketing teams to calibrate thresholds and filters that align with your lead quality standards and best practices to mmet regulatory requirements.

Troubleshooting

Frequently Asked Questions (FAQ)

Q: What is the Insights API Operation?
A: It is a TrustedForm feature that retrieves detailed metadata from a TrustedForm certificate, including technical details and behavioral data, to help evaluate lead quality and verify compliance.

Q: Why is the Insights API Operation important?
A: It provides granular visibility into consumer sessions by capturing metrics like lead age, browser type, time on page, and input methods, enabling businesses to make informed decisions and optimize lead acquisition strategies.

Q: How do I use the Insights API Operation?
A: To use it, obtain the TrustedForm Certificate URL, prepare an authenticated HTTP POST request per the API documentation with appropriate headers and desired properties in the request body, send the request to the certificate URL, and process the returned JSON response for integration into your lead management system.

Q: How fast is the Insights API Operation?
A: Response times are typically less than half of a second, though they can vary based on network conditions and server load, making it suitable for real-time integrations and decision-making.

Q: Is it possible for some data points to be missing from a certificate’s insights data?
A: Yes, if specific data is not avaialble the value returned will be null. This can happen because the data isn’t supported by the lead source or a technical issue prevented it from being captured.

Glossary