ClarmDocs
DashboardGitHub

REST API

The Clarm REST API provides programmatic access to visitors, conversations, analytics, and configuration. All endpoints require authentication.

Base URL

Base URLtext
https://api.clarm.com/api

Endpoints overview

GET/visitorsList all visitors with pagination
GET/visitors/:idGet visitor profile and events
GET/conversationsList chat sessions
GET/conversations/:idGet conversation with messages
POST/trackSend a tracking event
GET/analytics/overviewAggregate analytics for a date range
GET/analytics/funnelConversion funnel data
GET/agentsList configured agents
POST/agentsCreate or update an agent

Pagination

List endpoints support ?page=1&limit=50. Maximum limit is 100. Responses include total, page, and pages fields.

Rate limits

API requests are limited to 100 requests per minute per API key. Rate limit headers are included in every response:

Rate limit headerstext
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1707750000