Developers and inventors center

You can integrate your application/product directly into InApplet to obtain data or even create an application to use the platform in an innovative way.

If you already have a website or a product today, you can do an integration to:

  1. Get data that cannot be obtained by the plugin or front-end, such as information about customers, contacts and finances (revenues / plans).

  2. Create complete and personalized reports through direct consultation in the database.

You can also create a new application using InApplet as a platform:

  1. Innovate in how to get the data through a new plugin or using the API. You can collect various data such as: custom forms, information on interactions with games and a multitude of ways to

  2. show data in an innovative way so that they have a different view of that information. You can display data using metrics frameworks, with Data Science tools and even form responses.

The documentation is divided into two parts: Plugin and API.

About the plugin, we have a demonstration of how our plugin works and how you can make changes.

From the API, we demonstrate how to query data and record events.

Plugins

The plugin is a script that must be included before the closing of TAG on your website.

Through it it is possible to identify users and sessions and send event records such as views, clicks, form changes, form submissions and other events that can be inserted to InApplet.

Standard features of InApplet.JS

InApplet.JS is the standard plugin and it is suitable for analyzing traffic on websites.

You can obtain the script code by visiting https://www.inapplet.com/project/details/.

In InApplet.JS the following features are present:

  • Tracking events such as visualization, clicks and changes in forms.

  • Capture of properties referring to events such as browser information and UTMs in views, the elements (element information) that were clicked and which fields were changed in forms.

  • Identify your logged in customers by ID and send information about the customer.

  • In identification, it is possible to identify the user's previous visits before login even on different devices. (Recognition can be improved as the customer uses other devices).

How InApplet.JS

works The operation is very simple and can be divided into three stages:

  1. In the first stage, when the plugin is started, it opens a communication with the platform to obtain the session and pageview token.

  2. After interacting with the platform, it logs the viewing event by sending the tokens together with the browser, UTMs, URL and domain information.

  3. After registering the pageview, if other events happen, the plugin will also register automatically.

The registration of the logged user ID must be done manually.

How to send an event manually

A manual event must be sent after the InApplet.JS script starts. It can be after the script's initialization code or inside a .js file.

To send the event you must call the trackManual() function and pass the following parameters:

  • eventName: Name of the event;

  • properties: Properties and useful information of the event.

See below how we can use a manual event. In the example, we have a positive vote on a post.

var properties = {};
properties ['category'] = 'Seneca';
properties ['article'] ='How to start living a happy life?';
window.Inapplet.trackManual ('love_post', properties);

How to customize the plugin

The customization of the plugin can be done using InApplet.JS as available at https://www.inapplet.com/plugin/inapplet.js.

In some cases, initial initialization of session tokens and pageviews may not be necessary, as well as some DOM interaction functions.

At plugin startup, the name of the plugin must be changed, to avoid that in case the custom plugin is used together with InApplet.JS, conflicts do not happen.

API

When events do not occur during the visit on the page, the API can be used to record events and queries directly from the backend.

The endpoints used to record events are the same as those used in InApplet.JS. For data queries, a single endpoint can query all available data.

Logging events via API

Documentation for logging events is available on the postman (https://documenter.getpostman.com/view/41178/SztK14cQ?version=latest) and follows the same rules as the InApplet.JS event log endpoint .

Consultation of events and other information

The consultation of information can be done using the same SQL queries available in the function https://www.inapplet.com/explore/ of the dashboard.

The guideline is that tests are done on test projects, as the changes made to the endpoint /api/tenant/sql/ are changed directly in the project database and are irreversible.

The queries that can be performed are SELECT, INSERT, UPDATE and DELETE.

It is also possible to create the necessary indexes to optimize the response time of queries. View the indexes that can be created using EXPLAIN.

Documentation for using the functionality is available on the postman (https://documenter.getpostman.com/view/41178/SztK14cQ?version=latest).