Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).

GET

/broadcasts/{broadcastId}/metrics

curl --request GET \
  --url https://api.pingram.io/broadcasts/example/metrics \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

Parameters

Path Parameters

broadcastId

required

string

Broadcast ID

Responses

200

Successful response

Media typeapplication/json

Live send metrics. Counters are flattened at the top level.

object

total

required

number

sent

required

number

delivered

required

number

opened

required

number

clicked

required

number

bounced

required

number

complained

required

number

unsubscribed

required

number

skipped

required

number

failed

required

number

status

required

Lifecycle status of an email broadcast.

string

Allowed values: draft scheduled sending sent paused canceled

pausedReason

string

Allowed values: PAUSED_BY_USER REPUTATION_GUARD PLAN_EXCEEDED PENDING_VERIFICATION AUDIENCE_LIMITS_EXCEEDED UNVERIFIED_DOMAIN SPAM_CONTENT

scheduleAt

string

Example

{
  "status": "draft",
  "pausedReason": "PAUSED_BY_USER"
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}