Getting Started

This guide walks you through connecting Dicolytics to your bot. It takes about 5 minutes.

1. Create an Account

Sign in at dicolytics.com with your Discord account.

A personal organization is automatically created on your first login. Organizations manage projects and team members. You can invite teammates later to share dashboard access.

2. Create a Project

After signing in, the Create Project screen appears. One project corresponds to one Discord bot.

1. Enter your Discord Application ID — you can find it in the Discord Developer Portal
2. The bot name and avatar are fetched automatically from the ID
3. Set the project name, bot category, and timezone
4. Click Create

3. Get Your API Key

Once the project is created, your API key is displayed.

This key is shown only once, so copy it to a safe location immediately. If you lose it, you can revoke the old key and issue a new one from Settings > API Keys.

API keys start with dk_live_.

4. Install the SDK

Install the SDK for your bot's library.

discord.js (npm)

npm install @dicolytics/discord.js

discord.js (pnpm)

pnpm add @dicolytics/discord.js

discord.js (yarn)

yarn add @dicolytics/discord.js

discord.py (pip)

pip install dicolytics

Supported environments

• discord.js: v14.9+, Node.js 20+
• discord.py: v2.0+, Python 3.10+

5. Connect Your Bot

Add the SDK to your bot code. The connection method differs by library.

discord.js (TypeScript)

import { Client, GatewayIntentBits } from 'discord.js';
import { createDicolytics } from '@dicolytics/discord.js'; 

const client = new Client({
  intents: [GatewayIntentBits.Guilds],
});

const analytics = createDicolytics(client, { 
  apiKey: 'dk_live_YOUR_API_KEY_HERE',       
}); 

client.login('BOT_TOKEN');

discord.js (JavaScript)

const { Client, GatewayIntentBits } = require('discord.js');
const { createDicolytics } = require('@dicolytics/discord.js'); 

const client = new Client({
  intents: [GatewayIntentBits.Guilds],
});

const analytics = createDicolytics(client, { 
  apiKey: 'dk_live_YOUR_API_KEY_HERE',       
}); 

client.login('BOT_TOKEN');

discord.py

import discord
from dicolytics import create_dicolytics

bot = discord.Bot()
analytics = create_dicolytics(bot, api_key="dk_live_YOUR_API_KEY_HERE")

bot.run("BOT_TOKEN")

createDicolytics must be called before client.login(). If the order is reversed, some events may not be collected.

What the SDK does:

• Automatically collects interactions — slash commands, buttons, select menus, modals, and more
• Detects bot actions — message sends, role grants, member bans, etc.
• Aggregates events — member joins, message creates, channel updates, etc.
• Reports bot status (ping, memory, shard info) periodically

Message content is never collected.

6. Verify Connection

Start your bot and check the Dicolytics dashboard home for incoming data. The first data point usually appears within one minute.

If you don't see data:

1. Check your API key — make sure it's entered correctly and starts with dk_live_
2. Enable debug mode — add debug: true to the SDK options to see diagnostic logs in the console
3. Restart your bot — make sure you restarted the bot after installing the SDK
4. Check network — ensure HTTPS connections to api.dicolytics.com are not blocked from your server

const analytics = createDicolytics(client, {
  apiKey: 'dk_live_...',
  debug: true, // prints SDK diagnostic logs to console
});

7. Next Steps

Once you've verified the connection, check out these guides:

• Configuration — disable specific collection, adjust flush intervals, set up multi-cluster, and more
• Custom Events — collect your own events with track() and captureError()
• Dashboard Overview — learn how to use the home KPI tabs, reports, and realtime page
• Multi-cluster — set clusterId when running your bot across multiple processes