Skip to main content

​
API Reference

This section contains detailed documentation for all Doppel API endpoints.

​
Base URL

https://api.getdoppel.ai/api/v1

​
Available Endpoints

​
Interactions

MethodEndpointDescription
GET/interactionsList all interactions with filtering

​
Metrics

MethodEndpointDescription
GET/metrics/summaryGet aggregated KPIs
GET/metrics/outcomesGet outcome breakdown
GET/metrics/dailyGet daily time series

​
Campaigns

MethodEndpointDescription
GET/campaignsList all campaigns

​
Clinics

MethodEndpointDescription
GET/clinicsList all clinics

​
OpenAPI Specification

MethodEndpointDescription
GET/openapi.jsonGet OpenAPI 3.0 specification

​
Common Parameters

​
Pagination

Most list endpoints support pagination:
ParameterTypeDefaultDescription
pageinteger1Page number (1-indexed)
limitinteger25Items per page (max: 500)

​
Date Filtering

Many endpoints support date range filtering:
ParameterTypeFormatDescription
date_fromstringISO 8601Start date
date_tostringISO 8601End date
Example: 
?date_from=2024-01-01&date_to=2024-12-31

​
Response Format

All responses follow this structure: 
{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 25,
    "total": 150,
    "total_pages": 6,
    "has_more": true
  },
  "request_id": "uuid",
  "timestamp": "ISO 8601"
}