Skip to main content
POST
/
v2
/
api
/
analytics
/
outbound
Outbound metrics
curl --request POST \
  --url https://api.withallo.com/v2/api/analytics/outbound \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": {
    "from": "2026-03-25",
    "to": "2026-04-21"
  },
  "compare_date": {
    "from": "2026-02-25",
    "to": "2026-03-24"
  },
  "tags": [
    "meeting_booked"
  ],
  "granularity": "DAY"
}
'
{
  "data": {
    "date": {
      "from": "2026-03-25",
      "to": "2026-04-21"
    },
    "compare_date": {
      "from": "2026-03-25",
      "to": "2026-04-21"
    },
    "funnel": {
      "dials": {
        "count": {
          "value": 123,
          "previous": 123,
          "change": 123
        },
        "rate": 123
      },
      "connected": {
        "count": {
          "value": 123,
          "previous": 123,
          "change": 123
        },
        "rate": 123
      },
      "conversations": {
        "count": {
          "value": 123,
          "previous": 123,
          "change": 123
        },
        "rate": 123
      },
      "conversions": {
        "count": {
          "value": 123,
          "previous": 123,
          "change": 123
        },
        "rate": 123
      }
    },
    "time_series": {
      "dials": [
        {
          "date": "2023-12-25",
          "value": 123
        }
      ],
      "connected": [
        {
          "date": "2023-12-25",
          "value": 123
        }
      ],
      "connection_rate": [
        {
          "date": "2023-12-25",
          "value": 123
        }
      ],
      "conversions": [
        {
          "date": "2023-12-25",
          "value": 123
        }
      ]
    },
    "heatmap": {
      "dials": [
        {
          "day": "MONDAY",
          "hour": 123,
          "value": 123
        }
      ],
      "connected": [
        {
          "day": "MONDAY",
          "hour": 123,
          "value": 123
        }
      ],
      "connection_rate": [
        {
          "day": "MONDAY",
          "hour": 123,
          "value": 123
        }
      ]
    },
    "leaderboard": [
      {
        "user": {
          "id": "usr-abc123",
          "name": "John",
          "email": "[email protected]"
        },
        "connected": 123
      }
    ],
    "time_spent": {
      "avg_ringing_time_seconds": {
        "value": 123,
        "previous": 123,
        "change": 123
      },
      "avg_conversation_time_seconds": {
        "value": 123,
        "previous": 123,
        "change": 123
      },
      "total_conversation_time_seconds": {
        "value": 123,
        "previous": 123,
        "change": 123
      }
    },
    "last_updated": "2023-11-07T05:31:56Z",
    "items": {
      "data": [
        {
          "id": "cll-abc123",
          "user": {
            "id": "usr-abc123",
            "name": "John",
            "email": "[email protected]"
          },
          "allo_number": "+14155550100",
          "allo_number_label": "Sales US",
          "contact_number": "+14155551234",
          "stage": "DIAL",
          "voicemail": true,
          "duration": 123,
          "date": "2023-11-07T05:31:56Z"
        }
      ],
      "pagination": {
        "page": 123,
        "size": 123,
        "total_count": 123,
        "total_pages": 123,
        "has_more": true
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

Use this file to discover all available pages before exploring further.

Required scope: CONVERSATIONS_READ

​
Extend parameter

Use extend=items with a stage to include the actual list of outbound calls behind the funnel numbers in the response.
ValueRequiresEffect
itemsstageIncludes a paginated items field with the calls for the specified funnel stage

​
Stages

StageCalls included
DIALAll outbound dials
CONNECTEDCalls where the recipient picked up
CONVERSATIONConnected calls longer than 1 minute
CONVERSIONCalls tagged with one of the specified tags

​
Example with drilldown

{
  "date": { "from": "2026-04-14", "to": "2026-04-21" },
  "tags": ["meeting_booked"],
  "granularity": "DAY",
  "extend": "items",
  "stage": "CONVERSION",
  "page": 1,
  "size": 20
}
The response includes the full funnel metrics plus an items field with the paginated call list for the requested stage. Passing extend=items without stage returns a 400 error with code MISSING_PARAMETER.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
date
object
required
​
compare_date
object

Comparison period. Metrics will include change vs this period.

​
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
enum<string>
default:DAY

Time series granularity

Available options:
DAY,
WEEK,
MONTH
​
extend
enum<string>

Include the list of outbound calls behind the funnel numbers. Requires stage.

Available options:
items
​
stage
enum<string>

Filter drilldown items by funnel stage. Only used when extend=items.

Available options:
DIAL,
CONNECTED,
CONVERSATION,
CONVERSION
​
page
integer
default:1

Page number for drilldown items. Only used when extend=items.

​
size
integer
default:20

Page size for drilldown items. Only used when extend=items.

Required range: x <= 100

Response

Outbound analytics

​
data
object