Get email event statistics
Returns counts and rates for email events over a time range. The default start time is 30 days ago.
GET
/
email_events
/
stats
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.emailEvents.retrieveStats();
console.log(response.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.email_events.retrieve_stats()
print(response.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.EmailEvents.GetStats(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.emailEvents().retrieveStats();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.email_events.retrieve_stats
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->emailEvents->retrieveStats();
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-events retrieve-stats \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/email_events/stats \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "email_event_stats",
"counts": {
"queued": 0,
"sent": 0,
"delivered": 0,
"deferred": 0,
"bounced": 0,
"opened": 0,
"clicked": 0,
"complained": 0,
"unsubscribed": 0,
"failed": 0
},
"rates": {
"delivery_rate": 0,
"bounce_rate": 0,
"deferred_rate": 0,
"open_rate": 0,
"click_rate": 0,
"complaint_rate": 0
},
"time_range": {
"from": "2024-01-23T18:10:02.574Z",
"to": "2024-01-23T18:10:02.574Z"
}
}
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}Authorizations
Query Parameters
Was this page helpful?
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.emailEvents.retrieveStats();
console.log(response.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.email_events.retrieve_stats()
print(response.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.EmailEvents.GetStats(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.emailEvents().retrieveStats();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.email_events.retrieve_stats
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->emailEvents->retrieveStats();
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-events retrieve-stats \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/email_events/stats \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "email_event_stats",
"counts": {
"queued": 0,
"sent": 0,
"delivered": 0,
"deferred": 0,
"bounced": 0,
"opened": 0,
"clicked": 0,
"complained": 0,
"unsubscribed": 0,
"failed": 0
},
"rates": {
"delivery_rate": 0,
"bounce_rate": 0,
"deferred_rate": 0,
"open_rate": 0,
"click_rate": 0,
"complaint_rate": 0
},
"time_range": {
"from": "2024-01-23T18:10:02.574Z",
"to": "2024-01-23T18:10:02.574Z"
}
}
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}