Get call stats

GET

platform

calls

stats

Get call stats

curl --request GET \
  --url https://api.polymorfa.com/platform/calls/stats \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/calls/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/calls/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "groupBy": "day",
    "totals": {
      "calls": 1,
      "answered": 1,
      "missed": 1,
      "declined": 1,
      "failed": 1,
      "inProgress": 1,
      "answerRate": 0.5,
      "totalDurationSeconds": 1,
      "averageDurationSeconds": 1
    },
    "groups": [
      {
        "key": "<string>",
        "start": "2023-11-07T05:31:56Z",
        "calls": 1,
        "answered": 1,
        "missed": 1,
        "declined": 1,
        "failed": 1,
        "inProgress": 1,
        "answerRate": 0.5,
        "totalDurationSeconds": 1,
        "averageDurationSeconds": 1
      }
    ],
    "groupsTruncated": true,
    "heatmap": [
      {
        "dayOfWeek": 4,
        "hour": 11,
        "calls": 1,
        "answered": 1
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Query Parameters

projectId

string

Project to read. Omit to total every project in the organization.

sessionId

string

Identifier of the connected Polymorfa session.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters
Session name of one number.

Required string length: 1 - 128

direction

enum<string>

Specifies direction for this query parameter.

Allowed values

Value	Meaning
`inbound`	Inbound.
`outbound`	Outbound.

Available options:

inbound,

outbound

upstream

enum<string>

Specifies upstream for this query parameter.

Allowed values

Value	Meaning
`linked_device`	Linked device.
`cloud_api`	Cloud api.
How the number connects to WhatsApp.

Available options:

linked_device,

cloud_api

outcome

enum<string>

Specifies outcome for this query parameter.

Allowed values

Value	Meaning
`answered`	Answered.
`missed`	Missed.
`declined`	Declined.
`failed`	Failed.
`in_progress`	In progress.
How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a connection or capacity failure. `in_progress`: still ringing.

Available options:

answered,

missed,

declined,

failed,

in_progress

since

string<date-time>

Specifies since for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Include calls that started at or after this time.

until

string<date-time>

Specifies until for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Include calls that started before this time.

groupBy

enum<string>

default:day

Specifies group by for this query parameter.

Allowed values

Value	Meaning
`day`	Day.
`hour`	Hour.
`session`	Session.
`outcome`	Outcome.
`day` and `hour` return one group per bucket in `timezone`, covering at most 366 and 31 days. `session` returns one group per number, most calls first, up to 500. `outcome` returns one group per outcome.

Available options:

day,

hour,

session,

outcome

timezone

string

default:UTC

Specifies timezone for this query parameter.

Value constraints

Constraint	Accepted input
String length	At most `64` characters
IANA time zone name for day and hour buckets and the heatmap, such as `UTC`, `CET` or `Europe/Lisbon`; case does not matter and the response carries the canonical name. UTC offsets and POSIX strings such as `UTC+3` are not accepted.

Maximum string length: 64

Example:

"Europe/Lisbon"

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Get call stats

curl --request GET \
  --url https://api.polymorfa.com/platform/calls/stats \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/calls/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/calls/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "groupBy": "day",
    "totals": {
      "calls": 1,
      "answered": 1,
      "missed": 1,
      "declined": 1,
      "failed": 1,
      "inProgress": 1,
      "answerRate": 0.5,
      "totalDurationSeconds": 1,
      "averageDurationSeconds": 1
    },
    "groups": [
      {
        "key": "<string>",
        "start": "2023-11-07T05:31:56Z",
        "calls": 1,
        "answered": 1,
        "missed": 1,
        "declined": 1,
        "failed": 1,
        "inProgress": 1,
        "answerRate": 0.5,
        "totalDurationSeconds": 1,
        "averageDurationSeconds": 1
      }
    ],
    "groupsTruncated": true,
    "heatmap": [
      {
        "dayOfWeek": 4,
        "hour": 11,
        "calls": 1,
        "answered": 1
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Authorizations

Query Parameters

Response