GET
/
v1
/
calls
curl --request GET \
  --url https://api.eqho.ai/v1/calls \
  --header 'X-API-KEY: <api-key>'
{
  "calls": [
    {
      "_id": "<string>",
      "external_id": "<string>",
      "from_number": "<string>",
      "to_number": "<string>",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "call_type": "<string>",
      "conversation_medium": "<string>",
      "external_recording_url": "<string>",
      "transcript": [
        {
          "role": "<string>",
          "content": "<string>",
          "timestamp": 123
        }
      ],
      "disposition_level_1": "<string>",
      "disposition_level_2": "<string>",
      "disposition_level_3": "<string>",
      "call_summary": "<string>",
      "twilio_status": "<string>",
      "is_answer_machine": true,
      "lead_id": "<string>",
      "lead": {
        "_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "timezone": "<string>",
        "email": "<string>"
      },
      "agent_id": "<string>",
      "agent_name": "<string>",
      "campaign_id": "<string>",
      "campaign_name": "<string>",
      "account_id": "<string>",
      "service_version": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "call_count": 123,
      "is_dry_run": true,
      "call_metrics": {
        "ttfb": {
          "stt": {
            "values": [
              123
            ],
            "min": 123,
            "max": 123,
            "median": 123
          },
          "ai": {
            "values": [
              123
            ],
            "min": 123,
            "max": 123,
            "median": 123
          },
          "tts": {
            "values": [
              123
            ],
            "min": 123,
            "max": 123,
            "median": 123
          },
          "e2e": {
            "values": [
              123
            ],
            "min": 123,
            "max": 123,
            "median": 123
          }
        }
      },
      "credits_used": 123,
      "greeting_info": {
        "greeting": "<string>",
        "generation_schema_details": {
          "greeting_tone": "<string>",
          "greeting_length": "<string>",
          "medium_type_description": "<string>",
          "role_context_used": true,
          "greeting_examples": "<string>"
        },
        "ai_greeting_used": false,
        "ai_generation_timed_out": true,
        "ai_generation_failed": true
      },
      "duration_in_seconds": 123,
      "search_score": 123
    }
  ],
  "meta": {
    "per_page": 123,
    "last_page": 123,
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total": 123
  }
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
q
string | null

Search for a specific term across all fields.

​
offset
integer | null
default:1

The offset for the pagination. If not provided, the first 10 calls will be listed.

Required range: x >= 1
​
limit
integer | null
default:10

The maximum number of calls to return in the response. If not provided, 10 calls will be listed.

Required range: 1 <= x <= 1000
​
sort_by
string | null
default:start

Sort by a specific field. If not provided, calls will be sorted by start_date.

​
order_by
string | null
default:desc

Order by a specific field. If not provided, calls will be ordered by start_date in descending order.

​
start_date
string | null

Show calls including and after a specific date. Format: YYYY-MM-DD

​
end_date
string | null

Show calls including and before a specific date. Format: YYYY-MM-DD

​
campaign_id
string | null

Show calls for a specific campaign id.

​
call_type
enum<string> | null

Show calls of a specific type. If not provided, calls of all types will be shown.

Available options:
outbound,
inbound
​
disposition_level_3
string[] | null

Filter by one or more disposition values. You can pass multiple values like: ?disposition_level_3=1&disposition_level_3=2

​
agent_id
string | null

Show calls of a specific agent.

​
lead_id
string | null

Show calls of a specific lead.

​
filters
string | null

Filter calls by a specific field. Format: key=value

​
fields
string | null

Comma-separated list of call fields to return (e.g. 'call_type,from_number,status').

Response

200
application/json
Successful Response

The response is of type object.