A complete walkthrough of setting up your account, integrating with Zendesk, and viewing your first analytics.
Welcome to Customer Support AI Monitor! This comprehensive getting started guide will walk you through everything you need to begin monitoring, optimizing, and proving ROI from your AI customer support chatbots in under 15 minutes.
By the end of this guide, you'll have real-time visibility into your AI chatbot's CSAT scores, escalation rates, and performance metrics - with zero impact on your existing codebase.
Before you begin, make sure you have the following ready:
Setting up your Customer Support AI Monitor account is quick:
💡 Pro Tip: During onboarding, select your current support platform (Zendesk, Freshdesk) to get customized integration instructions.
Your API key authenticates requests to the Customer Support AI Monitor platform. Here's how to get it:
# Your API key looks like this:
amo_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0⚠️ Security Warning: Never commit API keys to version control or expose them in client-side code. Use environment variables instead.
Customer Support AI Monitor uses a simple REST API. You can integrate it from any programming language. Here are examples in Python and Node.js:
import requests
import os
from datetime import datetime
API_KEY = os.environ.get("CSAIMONITOR_API_KEY")
API_URL = "https://api.csaimonitor.com/api/v1"
def track_conversation(conversation_id, messages, csat_score=None, escalated=False, topic=None):
"""Track a customer support conversation"""
response = requests.post(
f"{API_URL}/conversations",
headers={
"X-API-Key": API_KEY,
"Content-Type": "application/json"
},
json={
"conversation_id": conversation_id,
"platform": "custom", # or "zendesk", "freshdesk", "sdk"
"messages": messages,
"csat_score": csat_score,
"escalated": escalated,
"ai_handled": True,
"topic": topic
}
)
return response.json()
# Example: After your AI handles a customer query
def handle_customer_query(user_message, customer_id):
# Your existing AI logic
ai_response = your_ai_model.generate_response(user_message)
# Track the conversation
track_conversation(
conversation_id=f"conv_{int(datetime.now().timestamp())}",
messages=[
{
"sender_type": "customer",
"content": user_message,
"timestamp": datetime.now().isoformat()
},
{
"sender_type": "ai",
"content": ai_response,
"timestamp": datetime.now().isoformat()
}
],
csat_score=5, # If you collect CSAT
escalated=False,
topic="general"
)
return ai_responseconst axios = require('axios');
const API_KEY = process.env.CSAIMONITOR_API_KEY;
const API_URL = 'https://api.csaimonitor.com/api/v1';
async function trackConversation(data) {
const response = await axios.post(
`${API_URL}/conversations`,
{
conversation_id: data.conversationId,
platform: 'custom',
messages: data.messages,
csat_score: data.csatScore,
escalated: data.escalated || false,
ai_handled: true,
topic: data.topic
},
{
headers: {
'X-API-Key': API_KEY,
'Content-Type': 'application/json'
}
}
);
return response.data;
}
// Express.js example
app.post('/chat', async (req, res) => {
const { query, customerId } = req.body;
// Your existing AI logic
const response = await yourAIModel.generateResponse(query);
// Track the conversation
await trackConversation({
conversationId: `conv_${Date.now()}`,
messages: [
{ sender_type: 'customer', content: query },
{ sender_type: 'ai', content: response }
],
csatScore: null, // Collect separately if available
escalated: false,
topic: 'general'
});
res.json({ response });
});curl -X POST https://api.csaimonitor.com/api/v1/conversations \
-H "X-API-Key: amo_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"conversation_id": "ticket_12345",
"platform": "zendesk",
"messages": [
{"sender_type": "customer", "content": "How do I reset my password?"},
{"sender_type": "ai", "content": "Go to Settings > Security > Reset Password."}
],
"csat_score": 5,
"escalated": false,
"ai_handled": true,
"topic": "password_reset"
}'💡 Tip: See our complete API documentation for all available fields, including cost tracking, sentiment analysis, and more.
For automatic conversation tracking from Zendesk, set up a webhook. This allows CSAT scores and escalation data to sync automatically:
https://api.csaimonitor.com/api/v1/webhooks/zendesk?org_id=YOUR_ORG_IDNote: If you don't use Zendesk, you can still track conversations manually using the REST API shown in Step 3. The webhook integration is optional but recommended for automatic CSAT collection.
Data typically appears within 2-5 minutes of your first tracked conversation. Here's what you'll see:
🎉 Congratulations! You've successfully set up Customer Support AI Monitor. Your AI chatbot is now being monitored in real-time!
Now that you're up and running, here are recommended next steps to maximize value:
Learn techniques to improve your CSAT scores by 20%+
Get notified when escalation rates spike
Identify and fix gaps in your AI's training
Prove the value of your AI investment
amo_)api.csaimonitor.comOur team is here to help you succeed:
You've completed this guide. Continue learning or start implementing what you've learned.
Start your free trial and put these concepts into practice.
Start Free Trial