Calls

Get call statistics

Retrieve aggregated call statistics including totals and counts.

Response includes:

  • Placed calls: total cost and count
  • Received calls: total cost and count
  • Missed calls: count only
  • All calls: combined total cost and count

Rows: calls_show.

get/api/v1/calls/statistics

Request

  • Base URL: https://app.didlogic.com
  • URL: https://app.didlogic.com/api/v1/calls/statistics
  • Auth: HTTP bearer

Query parameters

fromstring

Start date for filtering (YYYY-MM-DD)

tostring

End date for filtering (YYYY-MM-DD)

sipfriendinteger

SIP account name from sipaccounts_index

searchinteger

Search term for filtering calls

amd_statusstring

Count only calls with this answering machine detection (AMD) verdict, matched ignoring case:

  • machine — AMD detected an answering machine
  • human — AMD detected a person
  • notsure — AMD ran but could not tell a machine from a person, for example on silence, unclear audio or a timeout

Only outbound calls carry a verdict, so under this filter the received and missed counts and the received total are 0. A value that no call has gives zero counts and totals. A malformed value, for example one with | or non-ASCII characters, is ignored, as if the parameter were not sent.

hangup_cause'AMD_MACHINE' | 'NORMAL_CLEARING' | 'NO_ANSWER' | 'BUSY' | 'FAILED'

Count only calls that ended this way, matched ignoring case:

  • AMD_MACHINE — AMD detected an answering machine; takes precedence over the other values
  • NORMAL_CLEARING — the call was answered
  • NO_ANSWER — nobody answered, including calls the caller cancelled before an answer
  • BUSY — the called party was busy
  • FAILED — the call could not be connected

A value that no call has gives zero counts and totals. A malformed value, for example one with | or non-ASCII characters, is ignored, as if the parameter were not sent.

Response

returns call statistics

Example response

{
  "placed": {
    "total": "$15.0000"
  },
  "received": {
    "total": "$20.0000"
  },
  "all": {
    "total": "$35.0000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.