Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
funnels
/
{id}
/
analytics
Get pipeline analytics
curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels/{id}/analytics \
  --header 'api_access_token: <api-key>'
{
  "period": {
    "since": "2023-12-25",
    "until": "2023-12-25"
  },
  "total_created": 30,
  "total_won": 10,
  "total_lost": 4,
  "total_value_created": 150000,
  "total_value_won": 60000,
  "average_deal_size": 6000,
  "conversion_rate": 33.3,
  "by_agent": [
    {
      "agent": {
        "id": 1,
        "name": "Jane Smith",
        "email": "jane@example.com",
        "avatar_url": "<string>"
      },
      "created": 123,
      "won": 123,
      "value_won": 123
    }
  ],
  "by_stage": [
    {
      "stage_id": 123,
      "stage_name": "<string>",
      "count": 123,
      "value": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

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

Authorizations

​
api_access_token
string
header
required

API access token for authentication. Obtain from your Voxys Connect profile settings.

Path Parameters

​
account_id
integer
required

The numeric ID of the account.

​
id
integer
required

The ID of the pipeline.

Query Parameters

​
since
string<date>

Start date (inclusive) for analytics window.

​
until
string<date>

End date (inclusive) for analytics window.

​
agent_id
integer

Filter analytics to a specific agent.

​
group_by
enum<string>

Grouping dimension for time-series or breakdown data.

Available options:
day,
week,
month,
agent,
stage

Response

Pipeline analytics.

​
period
object
​
total_created
integer
Example:

30

​
total_won
integer
Example:

10

​
total_lost
integer
Example:

4

​
total_value_created
number<float>
Example:

150000

​
total_value_won
number<float>
Example:

60000

​
average_deal_size
number<float>
Example:

6000

​
conversion_rate
number<float>
Example:

33.3

​
by_agent
object[]
​
by_stage
object[]