Developer Portal

Build Powerful Analytics Integrations

Access our comprehensive API documentation, SDKs, and resources to integrate Compasslytics analytics into your applications.

Lightning Fast
Our API is optimized for performance with response times under 200ms for most queries.
Secure by Default
Enterprise-grade security with OAuth 2.0 authentication and role-based access control.
Well Documented
Comprehensive documentation with examples, guides, and interactive API explorer.
Easy Integration
SDKs available for all major languages with native integration patterns.

API Endpoints

POST/api/sources/connect
Register credentials and scopes
Parameters:
credentialsscopesconnectionType
POST/api/query
Ask questions using natural language
Parameters:
questionsourcesoutput
POST/api/dashboard
Generate interactive dashboard specification
Parameters:
layoutvisualizationsfilters
POST/api/chat/edit
Apply chat-based modifications
Parameters:
chatIdmodificationscontext
POST/api/templates/save
Save reusable workflow templates
Parameters:
templateNameconfigurationmetadata
POST/api/report
Export reports with interpretations
Parameters:
formattemplatescheduling

Quick Start

curl Example
curl -X POST https://api.compasslytics.com/v1/query \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "Explain revenue trends over the last quarter",
    "sources": ["salesforce", "stripe"],
    "output": ["dashboard", "narrative", "charts"]
  }'

Official SDKs

JavaScript/TypeScript
v2.5.1
npm install @compasslytics/sdk
Python
v3.2.0
pip install compasslytics-sdk
Ruby
v1.8.3
gem install compasslytics-sdk
Go
v1.2.0
go get github.com/compasslytics/sdk-go

Authentication

All API requests require an authentication token. You can obtain your API key from your dashboard settings.

Authentication Headers
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Developer Resources

Everything you need to build with Compasslytics

Documentation
Complete API reference and guides
GitHub
Open source SDKs and examples
API Explorer
Interactive API testing tool

Learn More

Platform Features

Discover all the powerful features of Compasslytics
View All Features →

Security & Compliance

Learn about our enterprise-grade security measures
View Security →

Pricing Plans

Choose the right plan for your integration needs
View Pricing →