Delivery analytics summary

GET

/analytics/summary

const url = 'https://mail.teamander.com/v1/analytics/summary?period=24h';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://mail.teamander.com/v1/analytics/summary?period=24h' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

period

Reporting window (default 30d)

string

Allowed values: 24h 7d 30d 90d

Example

30d

Responses

200

Summary metrics

application/json

object

period

required

string

total_sent

required

integer

delivered

required

integer

bounced

required

integer

failed

required

integer

complaint_rate

required

number

statuses

required

object

key

additional properties

integer

monthly_usage

required

Array<object>

object

key

additional properties

nullable

Example

{
  "period": "30d",
  "total_sent": 1280,
  "delivered": 1240,
  "bounced": 30,
  "failed": 10,
  "complaint_rate": 0.0016,
  "statuses": {
    "queued": 0,
    "sending": 0,
    "sent": 1240,
    "failed": 10,
    "bounced": 30,
    "complained": 2,
    "delivered": 0,
    "deferred": 0
  },
  "monthly_usage": []
}

400

Invalid period

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid period — must be one of: 24h, 7d, 30d, 90d"
}

401

Missing or invalid API key

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid API key"
}