This page provides an alphabetical list of terms and definitions used in the Insider Developer Guide, both as a reference and to promote a uniform understanding.
Algorithm
An algorithm is a set of well-defined rules or processes for accomplishing a task. Smart Recommender has a variety of algorithms that can work with different page types. They aim to increase clicks and conversions through machine learning.
AI - Artificial Intelligence
Artificial Intelligence allows machines to learn from experience, adapt to new information, and perform human-like activities by simulation.
Authentication Token
Authentication tokens are credentials that grant access to send requests to APIs.
Authorization
It is part of API security that requires users to apply for access. The authorized user is granted keys or a token.
API
API stands for Application Programming Interface. It includes a set of rules that define how application programs communicate with each other. For further information, refer to Insider APIs.
API Integration
API integration is the usage of APIs to enable communication between two web tools or applications.
API Key
An API key is the unique code that identifies and authenticates a user, application, or calling program to an API. For further information, refer to API Authentication Tokens.
API Request
The API request is the set of information to be submitted to the server to understand and return a response properly.
API Response
API response is a generic message the server sends back to the client after understanding and interpreting the request submitted.
Cache
It is a hardware or software component that stores certain elements to improve load times for future requests.
Callback
Callbacks allow you to receive notifications whenever an object changes or something significant happens to that object. APIs can use callbacks to signal an event of interest and share data related to that event.
CSS
CSS stands for Cascading Style Sheets. It is a programming language used in Front-End and, therefore, is responsible for defining the graphic display of websites by interacting with HTML elements.
CSV
CSV stands for Comma-Separated Values. It is a text file in a specific format that lets you save data in a table structure.
Endpoint
It is the location where APIs access the resources they require to perform their functions.
Headers
The server uses headers to pass additional information with requests and responses.
HTTP/HTTPS
HTTP stands for Hypertext Transfer Protocol. It is the protocol defining how devices communicate. A protocol with the S (Secure) at the end provides an encrypted connection. HTTPS should be used wherever personal data is processed.
Request Methods
Different types of HTTPS methods are available, and they basically tell the API what you’re trying to do with your data. Some of the common ones are;
- GET: getting information that already exists
- POST: creating something new
- PATCH: modifying information that already exists
- DELETE: removing information that already exists
- PUT: creating something new or updating information that already exists
Insider ID
insider_id, also known as Profile ID, is an internal ID maintained by the Insider for each user. To find the insider_id, you can refer to the Profile ID on the User Profile.
Insider Object
Insider Object is a JavaScript object that enables you to collect and access more user information, enhancing your site’s performance with Insider products.
- Page Object includes the properties of the current page (e.g., Home, Product, Listing, Confirmation).
- User Object includes the user properties.
- Listing Object includes information about a category or a search result page.
- Product Object includes the product properties.
- Basket Object includes the properties of the product(s) in the customer's basket.
- Transaction Object includes information on the completed purchase.
Insider Tag
Insider Tag is JavaScript code that must be integrated to track user behavior on your website, such as purchase data and visit history.
JSON
JSON stands for JavaScript Object Notation. It is a standard text-based format based on a subset of JavaScript programming language standards.
Metric
The metric is a quantifiable or countable measurement of a particular characteristic.
Parameters
- Header parameters: Parameters included in the request header usually relate to authorization.
- Body parameters: Parameters sent to the API to specify the data.
- Query parameters: Parameters attached to the end of a URL that help to define the specific content.
Payload
The payload is the essential data the server requires to generate a response.
SDK
SDK stands for Software Development Kit. It is a set of development tools to write application programs.
Syntax
Syntax is the structure of statements in a computer language. Each programming language has its unique syntax.
System Rules
System Rules are functions that define how your website's geography is understood and track customers’ activity throughout it—what pages they visit, which products they view or add to their cart, whether they complete their transaction, how many categories they visit, etc. System rules are defined by an Insider. If you integrate an Insider Object, the system rules are updated with the Insider Object.
Webhook
Webhooks are a way to augment or change the behavior of web pages through customized callbacks. They are typically used to connect two applications in real time to send event data and are considered an extension of APIs.