Intellix Edge Documentation

Welcome to the official documentation for Intellix Edge, the AI-powered business intelligence platform that transforms how you understand and leverage your business data.

Latest Updates (June 5, 2025)

  • Added new API endpoints for custom dashboard creation

  • Improved natural language processing capabilities

  • Enhanced data visualization options with new chart types

Table of Contents

What is Intellix Edge?

Intellix Edge is a comprehensive business intelligence platform designed to help teams of all sizes make data-driven decisions without the need for technical expertise. Our platform combines powerful data integration capabilities with advanced AI to provide real-time insights and actionable recommendations.

Built for Speed

Get up and running in minutes, not months. Our no-code setup process allows you to connect your data sources and start gaining insights immediately.

Powered by AI

Our advanced AI engine continuously analyzes your data to surface insights, identify trends, and provide recommendations that would otherwise require a team of analysts.

Platform Overview

Key Features

Zero-setup Integration

Connect your existing tools in minutes, not weeks. No technical expertise required.

AI-powered Insights

Our AI engine continuously analyzes your data to surface actionable insights and opportunities.

Natural Language Interface

Ask questions in plain English and get instant answers. No SQL or complex query languages.

Real-time Data

Make decisions based on what's happening now, not last week. Live updates across all metrics.

Quick Start Guide

Get started with Intellix Edge in just a few simple steps. This guide will walk you through the basics of setting up your account, connecting data sources, and creating your first dashboard.

1

Create Your Account

Sign up for Intellix Edge by visiting our registration page and following the prompts.

Shell
# Using our CLI tool (optional)
$ npm install -g intellix-edge-cli
$ intellix-edge init
$ intellix-edge auth login
2

Connect Your Data Sources

Intellix Edge supports over 50 popular business tools and platforms. Connect your first data source by following these steps:

  1. Navigate to the "Data Sources" section in your dashboard
  2. Click "Add New Data Source"
  3. Select your data source from the list of integrations
  4. Follow the authentication flow to connect your account

For optimal performance, we recommend connecting your most frequently used data sources first.

3

Create Your First Dashboard

Once your data sources are connected, you can create your first dashboard:

  1. Go to the "Dashboards" section
  2. Click "Create New Dashboard"
  3. Give your dashboard a name
  4. Add widgets by clicking "Add Widget" and selecting from available visualizations
  5. Configure each widget by selecting the data source and metrics you want to display
JavaScript
// Using our JavaScript SDK (optional)
import { IntellixEdge } from 'intellix-edge-sdk';
const client = new IntellixEdge({
apiKey: 'your-api-key'
});
// Create a new dashboard
const dashboard = await client.dashboards.create({
name: 'My First Dashboard',
description: 'A dashboard showing key metrics'
});
4

Ask Your First Question

Try out our natural language interface by asking a business question:

  1. Click on the "Ask" button in the top navigation
  2. Type a question like "What was our conversion rate last month?"
  3. Review the results and add them to your dashboard if desired

You can ask complex questions like "Compare our marketing spend to revenue by channel over the last 6 months" and Intellix Edge will generate the appropriate visualization.

Installation

Intellix Edge is primarily a cloud-based SaaS platform, but we also offer several installation options for enterprises with specific requirements.

Cloud Installation (Recommended)

Our cloud-based solution requires no installation. Simply sign up at app.intellixedge.com and you'll be up and running in minutes.

Benefits of Cloud Installation:

  • No infrastructure to maintain
  • Automatic updates and new features
  • Scalable resources based on your needs
  • 99.9% uptime guarantee

On-Premise Installation

For enterprises with strict data sovereignty requirements, we offer an on-premise solution that can be deployed in your own data center.

Shell
# Docker installation
$ docker pull intellixedge/server:latest
$ docker pull intellixedge/analytics:latest
$ docker pull intellixedge/frontend:latest
# Run using docker-compose
$ docker-compose up -d

For detailed on-premise installation instructions, please contact our enterprise sales team.

SDK Installation

We provide SDKs for several programming languages to help you integrate Intellix Edge into your existing applications.

JavaScript/Node.js
// Install via npm
$ npm install intellix-edge-sdk
// Install via yarn
$ yarn add intellix-edge-sdk
Python
# Install via pip
$ pip install intellix-edge
# Install via poetry
$ poetry add intellix-edge
Ruby
# Add to your Gemfile
gem 'intellix-edge'
# Then run
$ bundle install
Go
// Install via go get
$ go get github.com/intellixedge/sdk-go

System Requirements

Component Minimum Recommended
CPU 4 cores 8+ cores
RAM 8 GB 16+ GB
Disk Space 50 GB SSD 100+ GB SSD
Operating System Ubuntu 20.04, RHEL 8, Windows Server 2019 Ubuntu 22.04, RHEL 9, Windows Server 2022
Database PostgreSQL 13+ PostgreSQL 15+

API Reference

Intellix Edge provides a comprehensive REST API that allows you to integrate our platform with your existing systems and applications. This section covers authentication, available endpoints, and common error codes.

Authentication

All API requests must be authenticated using an API key. You can generate an API key from your account settings page.

HTTP Request
GET /api/v1/dashboards HTTP/1.1
Host: api.intellixedge.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Keep your API key secure and never expose it in client-side code. If you believe your API key has been compromised, you can regenerate it from your account settings.

API Key Scopes

When generating an API key, you can specify the scopes that determine what actions the key can perform:

Scope Description
read:dashboards Read-only access to dashboards
write:dashboards Create, update, and delete dashboards
read:data Read-only access to data sources and metrics
write:data Create, update, and delete data sources
read:users Read-only access to user information
write:users Create, update, and delete users (admin only)

Endpoints

Below are the main endpoints available in the Intellix Edge API. For a complete list, refer to our API Explorer.

Data Endpoints

GET /api/v1/data-sources

Returns a list of all data sources connected to your account.

Query Parameters
Parameter Type Description
page integer Page number (default: 1)
limit integer Results per page (default: 20, max: 100)
type string Filter by data source type
Example Response
JSON
{
"data": [
{
"id": "ds_123456",
"name": "Google Analytics",
"type": "google_analytics",
"status": "active",
"created_at": "2025-05-10T14:30:00Z",
"last_sync": "2025-06-05T08:15:22Z"
},
{
"id": "ds_789012",
"name": "Shopify Store",
"type": "shopify",
"status": "active",
"created_at": "2025-05-15T09:45:00Z",
"last_sync": "2025-06-05T07:30:15Z"
}
],
"meta": {
"total": 12,
"page": 1,
"limit": 20
}
}
POST /api/v1/data-sources

Creates a new data source connection.

Request Body
JSON
{
"name": "My Salesforce Account",
"type": "salesforce",
"credentials": {
"client_id": "your-client-id",
"client_secret": "your-client-secret",
"refresh_token": "your-refresh-token"
},
"settings": {
"sync_frequency": "hourly"
}
}
Example Response
JSON
{
"data": {
"id": "ds_345678",
"name": "My Salesforce Account",
"type": "salesforce",
"status": "pending",
"created_at": "2025-06-05T15:30:00Z",
"settings": {
"sync_frequency": "hourly"
}
}
}

User Endpoints

GET /api/v1/users

Returns a list of users in your organization. Requires admin privileges.

Example Response
JSON
{
"data": [
{
"id": "usr_123456",
"email": "sarah.johnson@example.com",
"name": "Sarah Johnson",
"role": "admin",
"created_at": "2025-03-15T10:30:00Z",
"last_login": "2025-06-04T16:45:22Z"
},
{
"id": "usr_789012",
"email": "michael.chen@example.com",
"name": "Michael Chen",
"role": "analyst",
"created_at": "2025-04-20T14:15:00Z",
"last_login": "2025-06-05T09:10:15Z"
}
],
"meta": {
"total": 8,
"page": 1,
"limit": 20
}
}

Analytics Endpoints

POST /api/v1/analytics/query

Executes a natural language query against your data sources.

Request Body
JSON
{
"query": "What was our conversion rate by channel last month?",
"data_sources": ["ds_123456", "ds_789012"],  // Optional
"format": "json"  // Options: json, csv, chart
}
Example Response
JSON
{
"data": {
"query": "What was our conversion rate by channel last month?",
"result": [
{
"channel": "Organic Search",
"conversion_rate": 3.2
},
{
"channel": "Paid Search",
"conversion_rate": 4.7
},
{
"channel": "Social Media",
"conversion_rate": 2.1
},
{
"channel": "Email",
"conversion_rate": 8.5
},
{
"channel": "Direct",
"conversion_rate": 5.3
}
],
"metadata": {
"time_period": "May 2025",
"data_sources": ["Google Analytics", "Shopify"],
"metrics": ["conversion_rate"],
"dimensions": ["channel"]
},
"suggested_visualization": "bar_chart"
}
}

Error Codes

When an API request fails, you'll receive an error response with a status code and message. Here are the common error codes you might encounter:

Status Code Error Type Description
400 Bad Request The request was invalid or malformed
401 Unauthorized Authentication failed or token is invalid
403 Forbidden You don't have permission to access this resource
404 Not Found The requested resource doesn't exist
429 Too Many Requests You've exceeded the rate limit
500 Internal Server Error Something went wrong on our end

Error Response Format

JSON
{
"error": {
"code": "forbidden",
"message": "You don't have permission to access this resource",
"details": "This action requires the 'write:users' scope"
}
}

Frequently Asked Questions

Find answers to common questions about Intellix Edge. If you don't see your question here, please contact our support team.

General Questions

What is Intellix Edge?

Intellix Edge is an AI-powered business intelligence platform that helps teams make data-driven decisions without requiring technical expertise. It connects to your existing tools, analyzes your data in real-time, and provides actionable insights through a natural language interface.

How is Intellix Edge different from traditional BI tools?

Unlike traditional BI tools that require data analysts and complex setup, Intellix Edge is designed for non-technical users. Key differences include:

  • No-code setup process
  • Natural language interface instead of SQL queries
  • Real-time data instead of periodic reports
  • AI-powered insights that surface opportunities automatically
  • Accessible pricing for teams of all sizes

What data sources can I connect to Intellix Edge?

Intellix Edge supports 50+ popular business tools and platforms, including:

Google Analytics
Shopify
Salesforce
HubSpot
QuickBooks
Stripe
Mailchimp
Facebook Ads
Google Ads

We're constantly adding new integrations. If you don't see your tool listed, contact us to request an integration.

Is my data secure with Intellix Edge?

Yes, we take data security very seriously. Intellix Edge implements industry-leading security practices:

  • SOC 2 Type II compliant
  • GDPR and CCPA compliant
  • All data encrypted in transit and at rest
  • Regular security audits and penetration testing
  • Role-based access controls
  • On-premise deployment option for enterprises with strict data sovereignty requirements

Troubleshooting

I'm having trouble connecting a data source. What should I do?

If you're experiencing issues connecting a data source, try these steps:

  1. Check that your credentials are correct and have the necessary permissions
  2. Ensure that your firewall isn't blocking our IP addresses
  3. Try disconnecting and reconnecting the data source
  4. Check our status page to see if there are any known issues with the specific integration
  5. Contact our support team for assistance

The natural language query isn't returning the expected results. How can I improve it?

To get better results from natural language queries:

  • Be specific about the metrics and time periods you're interested in
  • Use business terminology that matches your data sources
  • Try rephrasing your question if you're not getting the expected results
  • Check that all relevant data sources are connected and synced
  • Use the feedback button to help improve our natural language processing

Example: Instead of asking "How are sales?", try "What was our total revenue by product category for the last 3 months compared to the previous period?"

My dashboard is loading slowly. How can I improve performance?

If your dashboard is loading slowly, consider these optimizations:

  • Reduce the number of widgets on a single dashboard
  • Limit the date range for time-series data
  • Use filters to reduce the amount of data being processed
  • Check if any of your data sources are experiencing sync issues
  • Consider upgrading your plan if you're working with large datasets

Best Practices

How should I organize my dashboards?

For optimal dashboard organization:

  • Create separate dashboards for different departments or functions
  • Group related metrics together on the same dashboard
  • Use a consistent naming convention for dashboards and widgets
  • Include a mix of high-level KPIs and detailed metrics
  • Consider creating a "executive summary" dashboard for key stakeholders

What are some effective ways to use the AI insights feature?

To get the most out of AI insights:

  • Set up alerts for significant changes in key metrics
  • Schedule weekly insight reports to be delivered to your team
  • Use the "Ask Why" feature when you notice unusual patterns
  • Create follow-up questions based on initial insights
  • Share insights with relevant team members using the collaboration features

How can I ensure data quality in Intellix Edge?

To maintain high data quality:

  • Regularly check that data sources are syncing correctly
  • Set up data validation rules to flag potential issues
  • Use the data lineage feature to understand where metrics are coming from
  • Document custom metrics and calculations
  • Implement consistent naming conventions across data sources
  • Periodically audit access permissions to ensure data security