Statistiken
API-Endpunkte
| Rechenzentrum | API-Endpunkt |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Türkei | https://emailapi-tr.engagelab.com |
Hinweis:
Stellen Sie sicher, dass das gewählte Rechenzentrum zur entsprechenden Basis-URL passt.
Statistik der E-Mail-Versanddaten (pro Tag)
E-Mail-Versanddaten werden täglich ausgewertet.
URL
https://email.api.engagelab.cc/v1/stats_day
https://email.api.engagelab.cc/v1/stats_day
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(apiUser:apiKey) |
Beschreibung der Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| time_zone | string | nein | Zeitzone, z. B. +8 |
| start_date | string | ja | Startdatum (Format: yyyy-MM-dd) |
| end_date | string | ja | Enddatum (Format: yyyy-MM-dd) |
| api_users | string | nein | Statistik für bestimmte API_USER abfragen; mehrere API_USER durch Semikolon trennen (z. B. api_users=a;b;c) |
| label_ids | string | nein | Statistik für bestimmte Labels abfragen; mehrere Labels durch Semikolon trennen (z. B. label_ids=a;b;c) |
| domain_names | string | nein | Statistik für bestimmte Domains abfragen; mehrere Domains durch Semikolon trennen (z. B. domain_names=a;b;c) |
| aggregate_by | int (1, 0) | nein | Standard: 0; bei aggregate_by=1 werden aggregierte Daten zurückgegeben |
Hinweis:
Der abzufragende Zeitraum darf maximal 3 Monate betragen.
Beispiel für eine Anfrage:
curl "https://email.api.engagelab.cc/v1/stats_day?start_date=2015-02-01&end_date=2015-02-28&api_users=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_day?start_date=2015-02-01&end_date=2015-02-28&api_users=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_day?start_date=2015-02-01&end_date=2015-02-28&api_users=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_day?start_date=2015-02-01&end_date=2015-02-28&api_users=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| send_date (yyyy-MM-dd) | Versanddatum |
| api_user | API_USER |
| domain | Domain |
| label_id | Label-ID |
| label_name | Label-Name |
| targets | Gesamtzahl der Empfänger:innen (Anfragen) |
| sent | Gesamtzahl versendeter E-Mails |
| delivered | Anzahl zugestellter E-Mails |
| invalid_email | Anzahl ungültiger E-Mail-Adressen |
| soft_bounce | Anzahl Soft Bounces |
| report_spam | Anzahl Spam-Meldungen |
| total_clicks | Gesamtzahl der Klicks |
| total_opens | Gesamtzahl der Öffnungen |
| opens | Eindeutige Öffnungen |
| clicks | Eindeutige Klicks |
| unsubscribe | Anzahl der Abmeldungen |
| delivered_percent | Zustellungsrate in Prozent |
| invalid_email_percent | Anteil ungültiger E-Mails in Prozent |
| soft_bounce_percent | Anteil Soft Bounces in Prozent |
| report_spam_percent | Anteil Spam-Meldungen in Prozent |
| total_click_percent | Anteil Klicks in Prozent |
| total_open_percent | Anteil Öffnungen in Prozent |
| open_percent | Anteil eindeutiger Öffnungen in Prozent |
| click_percent | Anteil eindeutiger Klicks in Prozent |
| unsubscribe_percent | Anteil Abmeldungen in Prozent |
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"sent": 1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
}
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"sent": 1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
}
Diesen Codeblock im schwebenden Fenster anzeigen
Aggregierte Daten (aggregate_by = 1):
{
"result": {
"targets": 146013,
"sent": 13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
{
"result": {
"targets": 146013,
"sent": 13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlermeldung
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Diesen Codeblock im schwebenden Fenster anzeigen
Statistik der E-Mail-Versanddaten (pro Stunde)
E-Mail-Versanddaten werden stündlich ausgewertet.
URL
https://email.api.engagelab.cc/v1/stats_hour
https://email.api.engagelab.cc/v1/stats_hour
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(apiUser:apiKey) |
Beschreibung der Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| time_zone | string | nein | Zeitzone, z. B. +8 |
| send_date | string | ja | Versanddatum (Format: yyyy-MM-dd) |
| api_users | string | nein | Statistik für bestimmte API_USER abfragen; mehrere API_USER durch Semikolon trennen (z. B. api_users=a;b;c) |
| label_ids | string | nein | Statistik für bestimmte Labels abfragen; mehrere Labels durch Semikolon trennen (z. B. label_ids=a;b;c) |
Beispiel für eine Anfrage:
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| send_date (yyyy-MM-dd) | Versanddatum |
| send_hour | Stunde [0–23] |
| api_user | API_USER |
| label_id | Label-ID |
| targets | Gesamtzahl der Empfänger:innen (Anfragen) |
| sent | Gesamtzahl versendeter E-Mails |
| delivered | Anzahl zugestellter E-Mails |
| invalid_email | Anzahl ungültiger E-Mail-Adressen |
| soft_bounce | Anzahl Soft Bounces |
| report_spam | Anzahl Spam-Meldungen |
| total_clicks | Gesamtzahl der Klicks |
| total_opens | Gesamtzahl der Öffnungen |
| opens | Eindeutige Öffnungen |
| clicks | Eindeutige Klicks |
| unsubscribe | Anzahl der Abmeldungen |
| delivered_percent | Zustellungsrate in Prozent |
| invalid_email_percent | Anteil ungültiger E-Mails in Prozent |
| soft_bounce_percent | Anteil Soft Bounces in Prozent |
| report_spam_percent | Anteil Spam-Meldungen in Prozent |
| total_click_percent | Anteil Klicks in Prozent |
| total_open_percent | Anteil Öffnungen in Prozent |
| open_percent | Anteil eindeutiger Öffnungen in Prozent |
| click_percent | Anteil eindeutiger Klicks in Prozent |
| unsubscribe_percent | Anteil Abmeldungen in Prozent |
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent": 1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent": 1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent": 1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent": 1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlermeldung
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Diesen Codeblock im schwebenden Fenster anzeigen
Statistik ungültiger E-Mails (pro Tag)
Abfrage der klassifizierten Statistik ungültiger E-Mails.
URL
https://email.api.engagelab.cc/v1/stats_invalids
https://email.api.engagelab.cc/v1/stats_invalids
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(apiUser:apiKey) |
Beschreibung der Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| time_zone | string | nein | Zeitzone, z. B. +8 |
| start_date | string | nein | Startdatum (Format: yyyy-MM-dd) |
| end_date | string | nein | Enddatum (Format: yyyy-MM-dd) |
| api_users | string | nein | Statistik für bestimmte API_USER abfragen; mehrere API_USER durch Semikolon trennen (z. B. api_users=a;b;c) |
| label_ids | string | nein | Statistik für bestimmte Labels abfragen; mehrere Labels durch Semikolon trennen (z. B. label_ids=a;b;c) |
| domain_names | string | nein | Statistik für bestimmte Domains abfragen; mehrere Domains durch Semikolon trennen (z. B. domain_names=a;b;c) |
| aggregate_by | int (1, 0) | nein | Standard: 0; bei aggregate_by=1 werden aggregierte Daten zurückgegeben |
Hinweise:
- Wenn
aggregate_by=1, werden alle Daten aggregiert. - Wenn sowohl
label_idsals auchlabel_namesangegeben sind, wirdlabel_idsfür eine präzise Abfrage bevorzugt. Ist nurlabel_namesangegeben, erfolgt eine unscharfe Suche nach allen angegebenen Label-Namen.
Beispiel für eine Anfrage:
curl "https://email.api.engagelab.cc/v1/stats_invalids" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_invalids" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| send_date (yyyy-MM-dd) | Versanddatum |
| api_user | API_USER |
| domain | Domain |
| label_id | Label-ID |
| label_name | Label-Name |
| blacklists | Anzahl E-Mails auf der Engagelab-Blacklist |
| unsubscribes | Anzahl E-Mails auf der Abmeldeliste |
| server_errors | Nicht verfügbare ESP-Server |
| format_errors | Ungültige Empfängeradressen |
| ip_domain_rejecteds | Abgelehnte IPs oder Domains |
| not_exists | Nicht existierende Empfänger:innen |
| spams | Anzahl Spam-E-Mails |
| sender_recipient_rejecteds | Abgelehnte Absender:innen oder Empfänger:innen |
| others | Sonstige |
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
Diesen Codeblock im schwebenden Fenster anzeigen
Aggregierte Daten (aggregate_by = 1):
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlermeldung
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Diesen Codeblock im schwebenden Fenster anzeigen
