---
title: "Outbound metrics"
method: POST
path: "/v2/api/analytics/outbound"
tags: ["Analytics"]
---

# Outbound metrics

`POST /v2/api/analytics/outbound`

Returns outbound call metrics: dial funnel (dials → connected → conversations → conversions), time series, heatmap, leaderboard, and time spent metrics.

## Request body

- OutboundAnalyticsRequest
  - `date` AnalyticsDateRange, required
    - `from` string, date, required — Start date
    - `to` string, date, required — End date
  - `compare_date` AnalyticsDateRange
    - `from` string, date, required — Start date
    - `to` string, date, required — End date
  - `user_ids` string[] — Filter by user IDs. Cannot be combined with allo_numbers.
  - `allo_numbers` string[] — Filter by Allo numbers (E.164). Cannot be combined with user_ids.
  - `tags` string[] — Tag keys that define a conversion (e.g. ['meeting_booked', 'demo_scheduled'])
  - `granularity` 'DAY' | 'WEEK' | 'MONTH' — Time series granularity
  - `extend` 'items' — Include the list of outbound calls behind the funnel numbers. Requires `stage`.
  - `stage` 'DIAL' | 'CONNECTED' | 'CONVERSATION' | 'CONVERSION' — Filter drilldown items by funnel stage. Only used when `extend=items`.
  - `page` integer — Page number for drilldown items. Only used when `extend=items`.
  - `size` integer — Page size for drilldown items. Only used when `extend=items`.

## Response `200`

Outbound analytics

- object
  - `data` object
    - `date` AnalyticsDateRange
      - `from` string, date, required — Start date
      - `to` string, date, required — End date
    - `compare_date` AnalyticsDateRange
      - `from` string, date, required — Start date
      - `to` string, date, required — End date
    - `funnel` object
      - `dials` FunnelStage
        - `count` MetricValue
          - `value` number — Current period value
          - `previous` number, nullable — Previous period value
          - `change` number, nullable — Percentage change vs previous period (e.g. 0.15 = +15%)
        - `rate` number, nullable — Percentage of total dials (e.g. 0.29 = 29%)
      - `connected` FunnelStage
        - `count` MetricValue
          - `value` number — Current period value
          - `previous` number, nullable — Previous period value
          - `change` number, nullable — Percentage change vs previous period (e.g. 0.15 = +15%)
        - `rate` number, nullable — Percentage of total dials (e.g. 0.29 = 29%)
      - `conversations` FunnelStage
        - `count` MetricValue
          - `value` number — Current period value
          - `previous` number, nullable — Previous period value
          - `change` number, nullable — Percentage change vs previous period (e.g. 0.15 = +15%)
        - `rate` number, nullable — Percentage of total dials (e.g. 0.29 = 29%)
      - `conversions` FunnelStage
        - `count` MetricValue
          - `value` number — Current period value
          - `previous` number, nullable — Previous period value
          - `change` number, nullable — Percentage change vs previous period (e.g. 0.15 = +15%)
        - `rate` number, nullable — Percentage of total dials (e.g. 0.29 = 29%)
    - `time_series` object
      - `dials` TimeSeriesPoint[]
        - `date` string, date
        - `value` number
      - `connected` TimeSeriesPoint[]
        - `date` string, date
        - `value` number
      - `connection_rate` TimeSeriesPoint[]
        - `date` string, date
        - `value` number
      - `conversions` TimeSeriesPoint[]
        - `date` string, date
        - `value` number
    - `heatmap` object
      - `dials` HeatmapCell[]
        - `day` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
        - `hour` integer — Hour of day (0-23)
        - `value` integer
      - `connected` HeatmapCell[]
        - `day` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
        - `hour` integer — Hour of day (0-23)
        - `value` integer
      - `connection_rate` HeatmapCell[]
        - `day` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
        - `hour` integer — Hour of day (0-23)
        - `value` integer
    - `leaderboard` object[]
      - `user` UserRef
        - `id` string
        - `name` string
        - `email` string
      - `connected` integer
    - `time_spent` object
      - `avg_ringing_time_seconds` MetricValue
        - `value` number — Current period value
        - `previous` number, nullable — Previous period value
        - `change` number, nullable — Percentage change vs previous period (e.g. 0.15 = +15%)
      - `avg_conversation_time_seconds` MetricValue
        - `value` number — Current period value
        - `previous` number, nullable — Previous period value
        - `change` number, nullable — Percentage change vs previous period (e.g. 0.15 = +15%)
      - `total_conversation_time_seconds` MetricValue
        - `value` number — Current period value
        - `previous` number, nullable — Previous period value
        - `change` number, nullable — Percentage change vs previous period (e.g. 0.15 = +15%)
    - `last_updated` string, date-time — When the metrics were last updated
    - `items` object, nullable — Drilldown call list. Only present when extend=items is set.
      - `data` OutboundDrilldownItem[]
        - `id` string — Call ID
        - `user` UserRef
          - `id` string
          - `name` string
          - `email` string
        - `allo_number` string
        - `allo_number_label` string
        - `contact_number` string
        - `stage` 'DIAL' | 'CONNECTED' | 'CONVERSATION' | 'CONVERSION'
        - `voicemail` boolean
        - `duration` integer — Duration in seconds
        - `date` string, date-time
      - `pagination` Pagination
        - `page` integer
        - `size` integer
        - `total_count` integer
        - `total_pages` integer
        - `has_more` boolean

## Other responses

- `400` — Invalid request parameters
- `401` — Invalid or missing API key
- `429` — Rate limit exceeded

---

[API](https://skmtc.dev/withallo/apis/allo-api.md) · [All operations](https://skmtc.dev/withallo/apis/allo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withallo/allo-api/revisions/9aab4db82933/schema)