Skip to content
Kalipto Devs Platform — API Docs

Metrics

GET
/platform/v1/broadcasts/{broadcast_id}/metrics
 
curl --request GET \
  --url https://example.com/platform/v1/broadcasts/1/metrics

Per-recipient aggregate metrics (companion §4).

Errors: * 404 — not found / not owned.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
broadcast_id
required
Broadcast Id
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
PlatformBroadcastMetrics

Per-broadcast aggregate metrics — companion §4.

response_rate = responded / sent (0.0 when sent == 0). pending = total - (sent + failed) (where sent already includes the delivered/read/responded sub-statuses; the worker writes sent, the metrics read derives delivered/read/responded from the data-plane join).

object
delivered
required
Delivered
integer
failed
required
Failed
integer
pending
required
Pending
integer
read
required
Read
integer
responded
required
Responded
integer
response_rate
required
Response Rate
number
sent
required
Sent
integer
total
required
Total
integer
Example generated
{
  "delivered": 1,
  "failed": 1,
  "pending": 1,
  "read": 1,
  "responded": 1,
  "response_rate": 1,
  "sent": 1,
  "total": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}