Passer au contenu principal
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.

Scope requis : CONVERSATIONS_READ

​
Parametre extend

Utilisez extend=items avec un stage pour inclure la liste reelle des appels sortants derriere les chiffres de l’entonnoir dans la reponse.
ValeurRequisEffet
itemsstageInclut un champ pagine items avec les appels pour l’etape d’entonnoir specifiee

​
Etapes

EtapeAppels inclus
DIALTous les appels sortants
CONNECTEDAppels ou le destinataire a decroche
CONVERSATIONAppels connectes de plus d’une minute
CONVERSIONAppels tagges avec l’un des tags specifies

​
Exemple avec detail

{
  "date": { "from": "2026-04-14", "to": "2026-04-21" },
  "tags": ["meeting_booked"],
  "granularity": "DAY",
  "extend": "items",
  "stage": "CONVERSION",
  "page": 1,
  "size": 20
}
La reponse inclut les metriques completes de l’entonnoir plus un champ items avec la liste paginee des appels pour l’etape demandee. Passer extend=items sans stage retourne une erreur 400 avec le code MISSING_PARAMETER.

Autorisations

​
Authorization
string
header
requis

Corps

application/json
​
date
object
requis
​
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>
défaut:DAY

Time series granularity

Options disponibles:
DAY,
WEEK,
MONTH
​
extend
enum<string>

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

Options disponibles:
items
​
stage
enum<string>

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

Options disponibles:
DIAL,
CONNECTED,
CONVERSATION,
CONVERSION
​
page
integer
défaut:1

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

​
size
integer
défaut:20

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

Plage requise: x <= 100

Réponse

Outbound analytics

​
data
object