v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Incoming leads summary information

This method allows getting summary information about the incoming leads.

get/api/v4/leads/unsorted/summary

Query parameters

filter[uid]string[]

Filter by the incoming lead UID

filter[created_at]integer

Filter by creation date and incoming lead acceptance date. You can pass a timestamp, in which case data will be returned for the incoming lead created and received from the passed timestamp.

filter[created_at][from]integer

Filter by creation date and incoming lead acceptance date. You can pass a timestamp, in which case data will be returned for the incoming lead created and received from the passed timestamp.

filter[created_at][to]integer

Filter by creation date and incoming lead acceptance date. You can pass a timestamp, in which case data will be returned for the incoming lead created and received from the passed timestamp.

filter[pipeline_id]integer

Filter by the pipeline ID

Response

200

totalinteger

acceptedinteger

declinedinteger

average_sort_timeinteger

Example response

{
  "total": 6,
  "accepted": 1,
  "declined": 3,
  "average_sort_time": 44153027,
  "categories": {
    "sip": {
      "total": 2
    },
    "forms": {
      "total": 3
    },
    "chats": {
      "total": 1
    }
  }
}