Skip to main content

Data Source

The AgentVizion connector enables you to ingest insurance distribution data from Magnifact's AgentVizion platform into Nexla data flows. This connector is particularly useful for applications that need to consolidate agent book-of-business data, production metrics, commissions, pending application statuses, and carrier-integrated data from across your distribution network for reporting, analytics, and downstream processing.

The AgentVizion connector enables you to ingest insurance distribution data—including agent production, commissions, pending applications, and carrier-integrated data—from the AgentVizion platform into Nexla. Follow the instructions below to create a new data flow that ingests data from an AgentVizion source in Nexla.
agentvizion_api.png

AgentVizion

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the AgentVizion connector tile from the list of available connectors. Then, select the credential that will be used to connect to the AgentVizion instance, and click Next; or, create a new AgentVizion credential for use in this flow.

  3. In Nexla, Agent Vizion data sources can be created using pre-built endpoint templates, which expedite source setup for common Agent Vizion endpoints.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Agent Vizion endpoints. Each template is designed specifically for the corresponding Agent Vizion endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Policy Recon Report Data

    Fetch the AgentVizion Policy Recon Report Data.

    • Endpoint: POST https://{data_credential["agentvizion_api.base_url"]}.agentvizion.com/api/getAuthToken
    • Data path: $
    • From Date (Required): From date for fetching data (format: yyyy-MM-DD or use macros like {now-7})
    • To Date (Required): To date for fetching data (format: yyyy-MM-DD or use macros like {now-1})

    The From Date parameter is required to identify the specific resource to retrieve.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

AgentVizion sources can be configured to ingest data from any valid AgentVizion API endpoint. Configuration options available for AgentVizion sources allow them to be fully customized to suit any use case—including using chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

First, select the method that will be used for calls to the AgentVizion API from the Method pulldown menu. The most common methods are:

  • GET: For retrieving data from the API (most common for AgentVizion data ingestion)
  • POST: For sending data to the API or triggering actions
  • PUT: For updating existing data
  • PATCH: For partial updates to existing data
  • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the AgentVizion API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

    AgentVizion exposes RESTful API endpoints for key insurance distribution data objects. Common endpoint patterns include:

    • Agent and agency production data (e.g., /api/v1/agents, /api/v1/production)
    • Pending and submitted application statuses (aligned with IRI Digital First for Annuities Activity Status API standards)
    • Commission and payment data (e.g., /api/v1/commissions)
    • Book-of-business records across carriers and product lines (Health, Life, Annuities)
    • Carrier-integrated data feeds via DTCC connectivity

    Contact your Magnifact account representative or refer to the AgentVizion API Services documentation for the full list of available endpoints and their URL structures.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are particularly useful for AgentVizion endpoints that support date-range filtering, such as production data queries or application status reports filtered by submission date.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create AgentVizion API endpoints that reference specific agent IDs, carrier codes, or other identifiers from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the AgentVizion API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of agents or production records, the AgentVizion API will typically return an array of records along with metadata in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when AgentVizion API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the AgentVizion API response is in JSON format and includes a top-level array named data that contains the relevant records, the path to the response would be entered as $.data[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, when fetching a list of agent production records from the AgentVizion API, the response may include pagination context or request identifiers alongside the main data array. You can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving AgentVizion API response context such as request timestamps, pagination tokens, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for AgentVizion API versioning or to specify content type for endpoints that accept parameters in the request body.

    You do not need to include any headers already present in the credentials. The AgentVizion API key authentication header is handled automatically by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new AgentVizion data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.