Ctrlk
Go to website
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Analytics

Usage Summary

get

Usage summary grouped by event type and date.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
Responses
200

Successful Response

application/json
workspace_idstring · uuidRequired

Workspace identifier

period_startstring · dateRequired

Start of the reporting period

period_endstring · dateRequired

End of the reporting period

total_eventsintegerRequired

Total number of events in the period

get/v1/{workspace_id}/analytics/usage
GET /v1/{workspace_id}/analytics/usage HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "period_start": "2026-01-01",
  "period_end": "2026-01-01",
  "buckets": [
    {
      "event_type": "text",
      "event_date": "2026-01-01",
      "count": 1,
      "avg_duration_seconds": 1,
      "total_duration_seconds": 1
    }
  ],
  "total_events": 1
}

Call Stats

get

Call volume and duration statistics.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
Responses
200

Successful Response

application/json
workspace_idstring · uuidRequired

Workspace identifier

period_startstring · dateRequired

Start of the reporting period

period_endstring · dateRequired

End of the reporting period

total_callsintegerRequired

Total number of calls in the period

total_duration_secondsnumberRequired

Sum of all call durations in seconds

avg_duration_secondsnumberRequired

Average call duration in seconds

get/v1/{workspace_id}/analytics/calls
GET /v1/{workspace_id}/analytics/calls HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "period_start": "2026-01-01",
  "period_end": "2026-01-01",
  "total_calls": 1,
  "total_duration_seconds": 1,
  "avg_duration_seconds": 1,
  "calls_by_date": [
    {
      "date": "text",
      "count": 1,
      "avg_duration_seconds": 1
    }
  ]
}

Event Breakdown

get

Event volume breakdown by type and source.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
Responses
200

Successful Response

application/json
workspace_idstring · uuidRequired

Workspace identifier

period_startstring · dateRequired

Start of the reporting period

period_endstring · dateRequired

End of the reporting period

total_eventsintegerRequired

Total number of events in the period

get/v1/{workspace_id}/analytics/events
GET /v1/{workspace_id}/analytics/events HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "period_start": "2026-01-01",
  "period_end": "2026-01-01",
  "by_type": [
    {
      "key": "text",
      "count": 1
    }
  ],
  "by_source": [
    {
      "key": "text",
      "count": 1
    }
  ],
  "total_events": 1
}

Data Quality Analytics

get

Data quality metrics: confidence distribution, review pipeline stats, daily trends.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
Responses
200

Successful Response

application/json

Data quality metrics — confidence distribution, review pipeline stats.

workspace_idstring · uuidRequired

Workspace identifier

period_startstring · dateRequired

Start of the reporting period

period_endstring · dateRequired

End of the reporting period

total_eventsintegerRequired

Total number of events in the period

get/v1/{workspace_id}/analytics/data-quality
GET /v1/{workspace_id}/analytics/data-quality HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "period_start": "2026-01-01",
  "period_end": "2026-01-01",
  "confidence_distribution": [
    {
      "confidence_range": "text",
      "count": 1
    }
  ],
  "confidence_by_source": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "confidence_range": "text",
        "count": 1
      }
    ]
  },
  "review_pipeline": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "timeseries": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "total_events": 1
}

Analytics Dashboard

get

Composite analytics dashboard — top KPIs with period-over-period deltas.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90Optional

Period length in days

Default: 7
Responses
200

Successful Response

application/json

Composite dashboard — six headline KPIs, each with a delta, plus the period length.

Higher-is-better for call_volume, avg_quality, tool_success_rate; higher-is-worse for escalation_rate, avg_ttfb_ms, avg_duration_s. Consumers must color deltas by that per-KPI polarity, not by delta sign alone.

period_daysintegerRequired

Length of the reporting period in days

get/v1/{workspace_id}/analytics/dashboard
GET /v1/{workspace_id}/analytics/dashboard HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "call_volume": {
    "value": 1,
    "delta_pct": 1
  },
  "avg_quality": {
    "value": 1,
    "delta_pct": 1
  },
  "avg_ttfb_ms": {
    "value": 1,
    "delta_pct": 1
  },
  "escalation_rate": {
    "value": 1,
    "delta_pct": 1
  },
  "tool_success_rate": {
    "value": 1,
    "delta_pct": 1
  },
  "avg_duration_s": {
    "value": 1,
    "delta_pct": 1
  },
  "period_days": 1
}

Eval Quality Analytics

get

Production-eval pass-rate and score trends (channel-agnostic — voice, text, SMS, email).

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
intervalstring · enumOptionalDefault: 1dPossible values:
service_idstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json

Production-eval quality: overall pass-rate/score, per-eval-key breakdown, and a trend.

The channel-agnostic quality surface. Returns zeroed shapes (empty by_eval_key and trend, null rates) when no verdicts exist for the workspace/window — the console renders an empty-state rather than erroring, so this ships safely ahead of the eager-eval trigger being enabled in production.

get/v1/{workspace_id}/analytics/eval-quality
GET /v1/{workspace_id}/analytics/eval-quality HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "summary": {
    "eval_key": "text",
    "total_evals": 1,
    "judged": 1,
    "pass_rate": 1,
    "avg_score": 1
  },
  "by_eval_key": [
    {
      "eval_key": "text",
      "total_evals": 1,
      "judged": 1,
      "pass_rate": 1,
      "avg_score": 1
    }
  ],
  "trend": [
    {
      "date": "2026-01-01",
      "total_evals": 1,
      "judged": 1,
      "pass_rate": 1,
      "avg_score": 1
    }
  ]
}

Advanced Call Stats

get

Percentile-based call metrics: p50/p95/p99 for duration, quality, latency.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
intervalstring · enumOptionalDefault: 1dPossible values:
service_idstring · max: 64 · nullableOptional
directionstring · enum · nullableOptional

Filter by call direction: inbound or outbound

Possible values:
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/calls/advanced
GET /v1/{workspace_id}/analytics/calls/advanced HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Call Comparison

get

Period-over-period comparison of key call metrics.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
current_fromstring · dateRequired

Start of current period

current_tostring · dateRequired

End of current period

previous_fromstring · dateRequired

Start of previous period

previous_tostring · dateRequired

End of previous period

service_idstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/calls/comparison
GET /v1/{workspace_id}/analytics/calls/comparison?current_from=2026-01-01&current_to=2026-01-01&previous_from=2026-01-01&previous_to=2026-01-01 HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Call Quality Analytics

get

Call quality score trends, distribution, and summary statistics.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
intervalstring · enumOptionalDefault: 1dPossible values:
service_idstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json

Call quality score trends, distribution, and summary over time.

Served from the live Delta projection analytics.source_call_intelligence.

get/v1/{workspace_id}/analytics/call-quality
GET /v1/{workspace_id}/analytics/call-quality HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "summary": {
    "avg_quality_score": 1,
    "p50_quality_score": 1,
    "p95_quality_score": 1,
    "total_calls": 1,
    "escalation_rate": 1,
    "avg_duration_seconds": 1
  },
  "trend": [
    {
      "date": "text",
      "avg_quality": 1,
      "call_count": 1,
      "escalation_count": 1
    }
  ],
  "quality_distribution": {
    "excellent_90_100": 1,
    "good_70_89": 1,
    "fair_50_69": 1,
    "poor_0_49": 1
  }
}

Emotion Trends

get

Emotion distribution and valence/arousal trends.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
intervalstring · enumOptionalDefault: 1dPossible values:
service_idstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/emotion-trends
GET /v1/{workspace_id}/analytics/emotion-trends HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Latency Analytics

get

Voice latency metrics — p50/p95/p99 by component with trends.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
intervalstring · enumOptionalDefault: 1dPossible values:
service_idstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/latency
GET /v1/{workspace_id}/analytics/latency HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Tool Performance Analytics

get

Tool execution analytics — success rates, failure trends.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
intervalstring · enumOptionalDefault: 1dPossible values:
service_idstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/tool-performance
GET /v1/{workspace_id}/analytics/tool-performance HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Operator Performance Analytics

get

Operator escalation stats and quality comparison.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
intervalstring · enumOptionalDefault: 1dPossible values:
service_idstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json

Operator escalation performance and quality comparison over time.

get/v1/{workspace_id}/analytics/operator-performance
GET /v1/{workspace_id}/analytics/operator-performance HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "summary": {
    "total_calls": 1,
    "escalated_count": 1,
    "escalation_rate": 1,
    "operator_handled_count": 1,
    "avg_escalated_duration_seconds": 1,
    "avg_escalated_quality_score": 1,
    "avg_non_escalated_quality_score": 1
  },
  "trend": [
    {
      "date": "2026-01-01",
      "total_calls": 1,
      "escalated_count": 1
    }
  ]
}

Get Agent Analytics

get

Per-agent (service) call volume, completion rate, and avg duration.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
periodstring · max: 64 · nullableOptional
Responses
200

Successful Response

application/json
periodstring · nullableOptional
get/v1/{workspace_id}/analytics/agents
GET /v1/{workspace_id}/analytics/agents HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "agents": [
    {
      "agent_id": "123e4567-e89b-12d3-a456-426614174000",
      "agent_name": "text",
      "total_calls": 1,
      "completed_calls": 1,
      "avg_duration_seconds": 1,
      "completion_rate": 1
    }
  ],
  "period": "text"
}

Surface Completion Rates

get

Surface completion rates: overall, by source, time-bucketed trend.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
intervalstring · enumOptionalDefault: 1dPossible values:
entity_idstring · nullableOptional

Filter by entity ID

Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/surfaces/completion-rates
GET /v1/{workspace_id}/analytics/surfaces/completion-rates HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Surface Channel Effectiveness

get

Per-channel completion rate and average time to complete.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/surfaces/channel-effectiveness
GET /v1/{workspace_id}/analytics/surfaces/channel-effectiveness HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Surface Field Abandonment

get

Field-level drop-off analysis for abandoned surfaces.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
date_fromstring · date · nullableOptional
date_tostring · date · nullableOptional
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/surfaces/field-abandonment
GET /v1/{workspace_id}/analytics/surfaces/field-abandonment HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Entity Surface History

get

Per-entity surface history with preferred channel and completion stats.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
entity_idstring · uuidRequired
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault: 20
Responses
200

Successful Response

application/json
Other propertiesanyOptional
get/v1/{workspace_id}/analytics/surfaces/entity/{entity_id}
GET /v1/{workspace_id}/analytics/surfaces/entity/{entity_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
PreviousPipelineNextTraces

Last updated

Was this helpful?