Overview
The Lyftron Provider for Insightly offers the most natural way to access Insightly data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Insightly data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Insightly data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to Insightly.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Insightly, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Step1: Setup Insightly account
1.1 Create account in Insightly and login
1.2. After Login go to Profile -> User Setting and click on -> New API Key to generate Insightly Api key
Establishing a Connection with Lyftron's Quickstart Steps
Create your Insightly connection with Lyftron by following the 5 easy steps show below:
Step2 : Login to Lyftron
Start creating your connection
Step2.1 Add your connection
Click on Connect section on the left panel → Click on Add Connection button In the connector selection panel, search and click Insightly for your connection
Step2.2 Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Insightly connection with Lyftron.
Profile=C:\profiles\Insightly.apip;ProfileSettings='APIKey=[your_apikey];'Give connection name as Insightly -> Replace “your_api_key” with InsightlyApi-key, click on test connection -> click save. If connection is not successful so, check the error
| Key | Value | Field |
| Connection Name | Enter your connection details | Required |
| Profile | C:\profiles\Insightly.apip | Required |
| APIKey | your Insightly api_key | Required |
| Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
| Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Save your connection
Hurray! Now you have successfully connected with the Lyftron Insightly connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Step3 : Normalize
Create data source
After establishing connection, datasource metadata import is needed and for that Lyftron automatically normalize your API & different SQL dialects data into ANSI SQL format and also gives you API sources into simple, code less out of the box data model.
3.1 Click on Normalize section from the left panel -> Click on Add Data Source button, Enter data source name -> Choose Insightly from the existing connection list -> Click next
3.2 Choose the table you want to import and -> Click Create
Data Model
The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.
Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns.
| Name | Type | Description |
| ActivitySets | Tables | Gets a list of Activity Sets |
| CommentFileAttachments | Tables | Gets a Comment's File Attachments |
| Contacts | Tables | Gets a filtered list of Contacts |
| ContactsEmails | Tables | Gets a list of a Contact's Emails |
| ContactsEvents | Tables | Gets a Contact's Events |
| ContactsFileAttachments | Tables | Gets a Contact's File Attachments |
| ContactsFollow | Tables | Gets a Follow state for a Contact |
| ContactsLinks | Tables | Gets a Contact's Links |
| ContactsNotes | Tables | Gets a Contact's Notes |
| ContactsTasks | Tables | Gets a list of a Contact's Tasks |
| Countries | Tables | Gets a list of Countries used by Insightly |
| Currencies | Tables | Gets a list of Currencies used by Insightly |
| CustomFields | Tables | Gets a list of Custom Fields |
| CustomFieldsSearch | Tables | Gets a Custom Field by name |
| CustomObjects | Tables | Gets a list of custom objects |
| CustomObjectsCustomObjectName | Tables | Gets a custom object by object name |
| CustomObjectsRecords | Tables | Gets a filtered list of records |
| EmailComments | Tables | Gets an Email's Comments |
| EmailFileAttachments | Tables | Gets an Email's File Attachments |
| EmailFollow | Tables | Gets a Follow state for an Email |
| EmailLinks | Tables | Gets an Email's Links |
| Emails | Tables | Gets a filtered list of Emails |
| Events | Tables | Gets a filtered list of Events |
| EventsLinks | Tables | Gets an Event's Links |
| FileCategories | Tables | Gets a list of File Categories |
| Follows | Tables | Gets a list of followed records for the user |
| Instance | Tables | Gets the Instance |
| Leads | Tables | Gets a filtered list of Leads |
| LeadsEmails | Tables | Gets a list of a Lead's Emails |
| LeadsEvents | Tables | Gets a Lead's Events |
| LeadsFileAttachments | Tables | Gets a Lead's File Attachments |
| LeadsFollow | Tables | Gets a Follow state for a Lead |
| LeadsLinkEmailAddress | Tables | Gets the email address to use for linking with the Lead |
| LeadsLinks | Tables | Gets a Lead's Links |
| LeadsNotes | Tables | Gets a Lead's Notes |
| LeadSources | Tables | Gets a list of Lead Sources |
| LeadsTasks | Tables | Gets a list of a Lead's Tasks |
| LeadStatuses | Tables | Gets a list of Lead Statuses |
| Me | Tables | Gets the User object for the calling user. |
| Milestone | Tables | Gets a filtered list of Milestone |
| NoteLinks | Tables | Gets a Note's Links |
| Notes | Tables | Gets a filtered list of Notes |
| NotesComments | Tables | Gets a Note's Comments |
| NotesFileAttachments | Tables | Gets a Note's File Attachments |
| NotesFollow | Tables | Gets a Follow state for a Note |
| Opportunities | Tables | Gets a filtered list of Opportunities |
| OpportunitiesEmails | Tables | Gets a list of an Opportunity's Emails |
| OpportunitiesEvents | Tables | Gets an Opportunity's Events |
| OpportunitiesFileAttachments | Tables | Gets an Opportunity's File Attachments |
| OpportunitiesFollow | Tables | Gets a Follow state for an Opportunity |
| OpportunitiesLinkEmailAddress | Tables | Gets the email address to use for linking with the Opportunity |
| OpportunitiesLinks | Tables | Gets an Opportunity's Links |
| OpportunitiesNotes | Tables | Gets an Opportunity's Notes |
| OpportunitiesStateHistory | Tables | Gets the history of States and Reasons for an Opportunity. |
| OpportunitiesTasks | Tables | Gets a list of an Opportunity's Tasks |
| OpportunityCategories | Tables | Gets a list of Opportunity Categories |
| OpportunityStateReasons | Tables | Gets a list of Opportunity State Reasons |
| Organisations | Tables | Gets a filtered list of Organizations |
| OrganisationsEmails | Tables | Gets a list of an Organization's Emails |
| OrganisationsEvents | Tables | Gets an Organization's Events |
| OrganisationsFileAttachments | Tables | Gets an Organization's File Attachments |
| OrganisationsFollow | Tables | Gets a Follow state for an Organization |
| OrganisationsLinks | Tables | Gets an Organization's Links |
| OrganisationsNotes | Tables | Gets an Organization's Notes |
| OrganisationsTasks | Tables | Gets a list of an Organization's Tasks |
| Permissions | Tables | Gets the Permissions for a User |
| Pipelines | Tables | Gets a list of Pipelines |
| PipelineStages | Tables | Gets a list of Pipeline Stages |
| ProjectCategories | Tables | Gets a list of Project Categories |
| ProjectFileAttachments | Tables | Gets a Project's File Attachments |
| Projects | Tables | Gets a filtered list of Projects |
| ProjectsEmails | Tables | Gets a list of a Project's Emails |
| ProjectsEvents | Tables | Gets a Project's Events |
| ProjectsFollow | Tables | Gets a Follow state for a Project |
| ProjectsLinkEmailAddress | Tables | Gets the email address to use for linking with the Project |
| ProjectsLinks | Tables | Gets a Project's Links |
| ProjectsMilestones | Tables | Gets a list of a Project's Milestones |
| ProjectsNotes | Tables | Gets a Project's Notes |
| ProjectsTasks | Tables | Gets a list of a Project's Tasks |
| Relationships | Tables | Gets a list of Relationships |
| Tags | Tables | Gets a list of Tags used for a record type |
| TaskCategories | Tables | Gets a list of Task Categories |
| Tasks | Tables | Gets a filtered list of Tasks |
| TasksComments | Tables | Gets a Task's Comments |
| TasksFollow | Tables | Gets a Follow state for a Task |
| TasksLinks | Tables | Gets a Task's Links |
| TeamMembers | Tables | Gets a list of Team Members |
| Teams | Tables | Gets a list of Teams. |
| Users | Tables | Gets a filtered list of Users |
| UsersId | Tables | Gets a User |
Step 4: Analyze
Querying the data source data
Lyftron allows you to query the source data by simply writing the ANSI Sql query. Please keep in mind as the data is coming directly from API so, there’s a limit to API calls and performance delay from the Stripe API side which Lyftron can’t control so, don’t expect to pull millions of records in just fraction of seconds. If you have heavy data loads, create the pipeline to unload that data into the Lyftron warehouse and query from it.
3.1. Click on the analyze section on the left panel -> Choose data source from the list. Drag and drop the table -> Choose your querying options
3.2. Click on -> EXECUTE and selected query will return data successfully
Advanced Settings
To view a detailed advanced settings options, go to Insightly Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.