List usage records

GET

platform

usage

records

List usage records

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

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

fetch('https://api.polymorfa.com/platform/usage/records', 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/usage/records"

	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": {
    "records": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "meter": "call.duration",
        "quantity": 1,
        "unit": "second",
        "dimensions": {},
        "keySource": "none",
        "sourceKind": "call",
        "sourceId": "<string>",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "session": "<string>",
        "occurredAt": "2023-11-07T05:31:56Z",
        "recordedAt": "2023-11-07T05:31:56Z",
        "revision": 2,
        "pricingState": "unpriced",
        "rateCard": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "version": 123
        },
        "pricedCredits": 123
      }
    ],
    "nextCursor": "<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

Filter records to this project. Omit to list records from every project you can access.

session

string

Identifier of the connected Polymorfa session.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters
Number (session name).

Required string length: 1 - 128

callId

string

Identifier of the WhatsApp call.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters
Pattern	`^[\x21-\x7e]+$`

Required string length: 1 - 128

Pattern: ^[\x21-\x7e]+$

meter

enum<string>

Specifies meter for this query parameter.

Allowed values

Value	Meaning
`call.duration`	Call.duration.
`call.cloud_pulses`	Call.cloud pulses.
`campaign.call`	Campaign.call.
`tts.characters`	Tts.characters.
`tts.seconds`	Tts.seconds.
`stt.seconds`	Stt.seconds.
`agent.seconds`	Agent.seconds.
`agent.tokens`	Agent.tokens.
`agent.provider_cost`	Agent.provider cost.
`channels.peak`	Channels.peak.
`storage.byte_days`	Storage.byte days.
What was measured. Calls record `call.duration` (seconds) and, for outgoing Cloud API calls, `call.cloud_pulses` (6-second pulses). The other meters belong to voice automation and have no records yet.

Available options:

call.duration,

call.cloud_pulses,

campaign.call,

tts.characters,

tts.seconds,

stt.seconds,

agent.seconds,

agent.tokens,

agent.provider_cost,

channels.peak,

storage.byte_days

period

string

Specifies period for this query parameter.

Value constraints

Constraint	Accepted input
Pattern	`^\d{4}-(0[1-9]\|1[0-2])$`
Calendar month in UTC, `YYYY-MM`. Omit it to list records from every month.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$

limit

integer

default:25

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `100` (inclusive)

Required range: 1 <= x <= 100

cursor

string

Specifies cursor for this query parameter.

Value constraints

Constraint	Accepted input
String length	`1` through `256` characters

Required string length: 1 - 256

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

List usage records

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

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

fetch('https://api.polymorfa.com/platform/usage/records', 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/usage/records"

	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": {
    "records": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "meter": "call.duration",
        "quantity": 1,
        "unit": "second",
        "dimensions": {},
        "keySource": "none",
        "sourceKind": "call",
        "sourceId": "<string>",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "session": "<string>",
        "occurredAt": "2023-11-07T05:31:56Z",
        "recordedAt": "2023-11-07T05:31:56Z",
        "revision": 2,
        "pricingState": "unpriced",
        "rateCard": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "version": 123
        },
        "pricedCredits": 123
      }
    ],
    "nextCursor": "<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

List usage records

Authorizations

Query Parameters

Response