Analytics API

The Analytics API provides programmatic access to Synaptiq's sales intelligence data. Retrieve summary metrics, conversion funnel breakdowns, and granular activity feeds to power dashboards, reports, and data pipelines.

Overview Metrics

Returns high-level summary metrics for your Synaptiq account over a specified date range.

Query Parameters

Parameter	Type	Required	Description
startDate	string	No	ISO 8601 date. Start of the reporting period. Default: 30 days ago.
endDate	string	No	ISO 8601 date. End of the reporting period. Default: today.
granularity	string	No	Data granularity: day, week, month. Default: day.
compareWith	string	No	Compare with a previous period: previous_period, previous_year.

Request

curl "https://synaptiqintel.com/api/v1/analytics/overview?startDate=2026-03-01&endDate=2026-03-31&granularity=week" \
  -H "Authorization: Bearer sk_live_abc123def456ghi789jkl012mno345"

Response

{
  "period": {
    "startDate": "2026-03-01",
    "endDate": "2026-03-31"
  },
  "summary": {
    "totalConversations": 3847,
    "totalLeads": 612,
    "qualifiedLeads": 289,
    "conversionRate": 0.0751,
    "avgLeadScore": 54.3,
    "avgResponseTime": 1.2,
    "avgMessagesPerConversation": 8.4,
    "handoffRate": 0.12,
    "totalRevenuePipeline": 847500.00
  },
  "comparison": null,
  "timeSeries": [
    {
      "period": "2026-03-01/2026-03-07",
      "conversations": 892,
      "leads": 143,
      "qualifiedLeads": 67,
      "conversionRate": 0.0751
    },
    {
      "period": "2026-03-08/2026-03-14",
      "conversations": 1021,
      "leads": 168,
      "qualifiedLeads": 82,
      "conversionRate": 0.0803
    },
    {
      "period": "2026-03-15/2026-03-21",
      "conversations": 978,
      "leads": 152,
      "qualifiedLeads": 71,
      "conversionRate": 0.0726
    },
    {
      "period": "2026-03-22/2026-03-31",
      "conversations": 956,
      "leads": 149,
      "qualifiedLeads": 69,
      "conversionRate": 0.0722
    }
  ]
}

Summary Fields

Field	Type	Description
totalConversations	integer	Total AI conversations during the period.
totalLeads	integer	New leads captured during the period.
qualifiedLeads	integer	Leads that reached qualified status.
conversionRate	number	Percentage of conversations that generated a lead.
avgLeadScore	number	Average lead score across all new leads.
avgResponseTime	number	Average AI response time in seconds.
avgMessagesPerConversation	number	Average number of messages per conversation.
handoffRate	number	Percentage of conversations handed off to a human agent.
totalRevenuePipeline	number	Estimated revenue pipeline from qualified leads (USD).

Period Comparison

Pass compareWith=previous_period to include a comparison object:

curl "https://synaptiqintel.com/api/v1/analytics/overview?startDate=2026-03-01&endDate=2026-03-31&compareWith=previous_period" \
  -H "Authorization: Bearer sk_live_abc123def456ghi789jkl012mno345"

The response includes a comparison field:

{
  "comparison": {
    "period": {
      "startDate": "2026-01-30",
      "endDate": "2026-02-28"
    },
    "totalConversations": { "value": 3102, "change": 0.24 },
    "totalLeads": { "value": 498, "change": 0.23 },
    "qualifiedLeads": { "value": 221, "change": 0.31 },
    "conversionRate": { "value": 0.0712, "change": 0.055 }
  }
}

The change values are expressed as decimals (e.g., 0.24 = 24% increase).

Conversion Funnel

Returns stage-by-stage conversion funnel data showing how visitors move through the sales pipeline.

Query Parameters

Parameter	Type	Required	Description
startDate	string	No	ISO 8601 date. Default: 30 days ago.
endDate	string	No	ISO 8601 date. Default: today.
channel	string	No	Filter by channel: web_chat, api, whatsapp, slack.
source	string	No	Filter by lead source: chat, api, import, form.

Request

curl "https://synaptiqintel.com/api/v1/analytics/funnel?startDate=2026-03-01&endDate=2026-03-31" \
  -H "Authorization: Bearer sk_live_abc123def456ghi789jkl012mno345"

Response

{
  "period": {
    "startDate": "2026-03-01",
    "endDate": "2026-03-31"
  },
  "stages": [
    {
      "name": "Visitors",
      "count": 18420,
      "conversionToNext": 0.209
    },
    {
      "name": "Engaged (Started Chat)",
      "count": 3847,
      "conversionToNext": 0.159
    },
    {
      "name": "Lead Captured",
      "count": 612,
      "conversionToNext": 0.472
    },
    {
      "name": "Qualified",
      "count": 289,
      "conversionToNext": 0.346
    },
    {
      "name": "Demo Booked",
      "count": 100,
      "conversionToNext": 0.620
    },
    {
      "name": "Converted",
      "count": 62,
      "conversionToNext": null
    }
  ],
  "overallConversion": 0.00337,
  "topDropoffStage": "Visitors -> Engaged (Started Chat)"
}

Stage Fields

Field	Type	Description
name	string	Human-readable stage name.
count	integer	Number of visitors/leads at this stage.
conversionToNext	number	Conversion rate to the next stage. null for the final stage.

Activity Feed

Returns a chronological feed of notable events across your account: new leads, qualifications, handoffs, conversions, and high-intent signals.

Query Parameters

Parameter	Type	Required	Description
startDate	string	No	ISO 8601 date. Default: 24 hours ago.
endDate	string	No	ISO 8601 date. Default: now.
type	string	No	Filter by event type (see table below). Comma-separated.
leadId	string	No	Filter activities for a specific lead.
page	integer	No	Page number. Default: 1.
limit	integer	No	Results per page. Max: 100. Default: 50.

Activity Event Types

Type	Description
lead.created	A new lead was captured.
lead.qualified	A lead's status changed to qualified.
lead.score_changed	A lead's score increased or decreased significantly.
conversation.started	A new conversation was initiated.
conversation.handoff	A conversation was handed off to a human agent.
conversion.completed	A lead converted (closed-won).
intent.high_value	A high-value buying intent was detected.

Request

curl "https://synaptiqintel.com/api/v1/analytics/activity?type=lead.qualified,intent.high_value&limit=5" \
  -H "Authorization: Bearer sk_live_abc123def456ghi789jkl012mno345"

Response

{
  "data": [
    {
      "id": "evt_01HQ8AAA1BBB2CCC3DDD4EEE5F",
      "type": "intent.high_value",
      "leadId": "lead_01HQ3VXK9BWMN4F6T2P8R5GYSC",
      "conversationId": "conv_01HQ7ABC2DEF3GHI4JKL5MNO6P",
      "description": "High-value buying intent detected: visitor requested enterprise pricing for 50+ seats.",
      "metadata": {
        "intent": "enterprise_pricing",
        "confidence": 0.94,
        "estimatedDealSize": 45000
      },
      "occurredAt": "2026-04-05T11:42:00.000Z"
    },
    {
      "id": "evt_01HQ8FFF6GGG7HHH8III9JJJ0K",
      "type": "lead.qualified",
      "leadId": "lead_01HQ6JKL8MWPN3D5R7S9T1UVWX",
      "conversationId": "conv_01HQ7QRS8TUV9WXY0ZAB1CDE2F",
      "description": "Lead qualified based on conversation scoring: CTO at FinTech startup, budget confirmed.",
      "metadata": {
        "previousStatus": "new",
        "newStatus": "qualified",
        "scoreChange": { "from": 22, "to": 64 }
      },
      "occurredAt": "2026-04-05T10:48:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 5,
    "total": 23,
    "totalPages": 5,
    "hasMore": true
  }
}

Error Responses

Status Code	Error	Description
400	invalid_request	Invalid date format or query parameters.
401	unauthorized	Invalid or missing API key.
422	unprocessable	Date range exceeds maximum of 365 days.