Get aggregate email statistics
curl --request GET \
--url https://api.mail.gorillaa.one/v1/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mail.gorillaa.one/v1/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mail.gorillaa.one/v1/stats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mail.gorillaa.one/v1/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mail.gorillaa.one/v1/stats"
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))
}HttpResponse<String> response = Unirest.get("https://api.mail.gorillaa.one/v1/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mail.gorillaa.one/v1/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"stats": {
"total": 123,
"queued": 123,
"sending": 123,
"sent": 123,
"delivered": 123,
"bounced": 123,
"failed": 123,
"opens": 123,
"clicks": 123,
"deliveryRate": 50,
"openRate": 50,
"clickRate": 50,
"bounceRate": 50
}
}
}{
"error": {
"code": "invalid_request",
"message": "Request validation failed",
"details": {
"validation": {
"subject": [
"Subject is required"
]
}
},
"suggestion": "Check the request body against the API documentation"
}
}{
"error": {
"code": "invalid_api_key",
"message": "Invalid API key provided",
"suggestion": "Include a valid API key in the Authorization header: Bearer grl_live_..."
}
}Statistics
Get aggregate email statistics
Returns aggregated delivery metrics for a date range: totals, delivery/open/click/bounce rates.
Requires stats:read scope.
GET
/
v1
/
stats
Get aggregate email statistics
curl --request GET \
--url https://api.mail.gorillaa.one/v1/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mail.gorillaa.one/v1/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mail.gorillaa.one/v1/stats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mail.gorillaa.one/v1/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mail.gorillaa.one/v1/stats"
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))
}HttpResponse<String> response = Unirest.get("https://api.mail.gorillaa.one/v1/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mail.gorillaa.one/v1/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"stats": {
"total": 123,
"queued": 123,
"sending": 123,
"sent": 123,
"delivered": 123,
"bounced": 123,
"failed": 123,
"opens": 123,
"clicks": 123,
"deliveryRate": 50,
"openRate": 50,
"clickRate": 50,
"bounceRate": 50
}
}
}{
"error": {
"code": "invalid_request",
"message": "Request validation failed",
"details": {
"validation": {
"subject": [
"Subject is required"
]
}
},
"suggestion": "Check the request body against the API documentation"
}
}{
"error": {
"code": "invalid_api_key",
"message": "Invalid API key provided",
"suggestion": "Include a valid API key in the Authorization header: Bearer grl_live_..."
}
}Authorizations
API key authentication. Pass your Gorillaa Mail API key as a Bearer token.
Example: Authorization: Bearer grl_live_xxxxxxxxxxxx
Keys prefixed grl_test_ operate in test mode with reduced limits.
Query Parameters
Start of date range (ISO 8601 datetime)
End of date range (ISO 8601 datetime). Must be after start_date.
Filter by specific domain UUID
Response
Aggregate statistics
Show child attributes
Show child attributes