Statistiken
Statistiken der Versanddaten (pro Tag)
SMS-Versanddaten nach Tag gezählt
URL
https://sms.api.engagelab.cc/v1/stats_day
https://sms.api.engagelab.cc/v1/stats_day
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Anfragemethode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Anfrage-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | string | ja | Basic base64(sms_user:sms_key) |
Beschreibung der Abfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| time_zone | string | nein | Zeitzone, z. B.: +8 |
| template_ids | string | nein | Mehrere Template-IDs, getrennt durch ;, z. B. template_ids=1;2;3. Unterstützt bis zu 10 IDs |
| sms_users | string | nein | Statistische Daten für spezifische SMS_USER abrufen, mehrere durch ; getrennt, z. B. sms_users=a;b;c. Bis zu 10 unterstützt |
| label_ids | string | nein | Liste von SMS-Tag-IDs, getrennt durch ;, z. B. label_ids=123456;456789, unterstützt bis zu 10 |
| start_date | string | ja | Startdatum, Format yyyy-MM-dd |
| end_date | string | ja | Enddatum, Format yyyy-MM-dd |
| msg_type | string | nein | SMS-Typ, 2 steht für internationale SMS |
| aggregate_by | string | nein | Standardwert ist 0; wenn aggregate=1, werden aggregierte Daten zurückgegeben |
Hinweise:
- Der maximale Abfragezeitraum darf 90 Tage nicht überschreiten.
- Wenn 'aggregate_by' den Wert 1 hat, wird die Datenaggregation nach 'msg_type' durchgeführt; Wenn 'aggregate_by' 0 ist, erfolgt keine Aggregation.
Anfragebeispiel
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung des Rückgabewerts
| Parameter | Beschreibung |
|---|---|
| send_date | Versanddatum |
| msg_type | SMS-Typ |
| sms_user | SMS_USER |
| template_id | SMS-Template-ID |
| label_id | Label-ID |
| targets | Gesamtanzahl der Empfänger (Anfragen) |
| sent | Gesamtanzahl versendeter Nachrichten |
| process_failed | Anzahl fehlgeschlagener Verarbeitungen |
| delivered | Anzahl zugestellter Nachrichten |
| send_failed | Anzahl fehlgeschlagener Sendungen |
| wait_result | Anzahl in Warteposition |
| billing_count | Anzahl für die Abrechnung |
| process_failed_percent | Anteil fehlgeschlagener Verarbeitungen |
| delivered_percent | Anteil zugestellter Nachrichten |
| send_failed_percent | Anteil fehlgeschlagener Sendungen |
| wait_result_percent | Anteil in Warteposition |
Rückgabebeispiel
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}],
"count": 1
}
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}],
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Verarbeitungsfehler
Klassifizierte Statistik fehlgeschlagener Verarbeitung
URL
https://sms.api.engagelab.cc/v1/stats/process_failed
https://sms.api.engagelab.cc/v1/stats/process_failed
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Anfragemethode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Anfrage-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(smsUser:smsKey) |
Beschreibung der Abfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| time_zone | string | nein | Zeitzone, z. B.: +8 |
| sms_users | string | nein | Statistische Daten für spezifische SMS_USER abrufen, mehrere durch ; getrennt, z. B. sms_users=a;b;c. Bis zu 10 unterstützt |
| start_date | string | ja | Startdatum, Format yyyy-MM-dd |
| end_date | string | ja | Enddatum, Format yyyy-MM-dd |
| msg_type | string | nein | SMS-Typ, 2 steht für internationale SMS |
| label_ids | string | nein | Liste von SMS-Tag-IDs, getrennt durch ;, z. B. label_ids=123456;456789, unterstützt bis zu 10 |
| template_ids | string | nein | Mehrere Template-IDs, getrennt durch ;, z. B. template_ids=1;2;3. Unterstützt bis zu 10 IDs |
| aggregate_by | string | nein | Standardwert ist 0; wenn aggregate=1, werden aggregierte Daten zurückgegeben |
Hinweise:
- Der maximale Abfragezeitraum darf 90 Tage nicht überschreiten.
- Wenn 'aggregate_by' den Wert 1 hat, wird die Datenaggregation nach 'msg_type' durchgeführt; Wenn 'aggregate_by' 0 ist, erfolgt keine Aggregation.
Anfragebeispiel
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung des Rückgabewerts
| Parameter | Beschreibung |
|---|---|
| send_date | Versanddatum |
| label_id | Label-ID |
| msg_type | SMS-Typ |
| sms_user | SMS_USER |
| template_id | SMS-Template-ID |
| global_block | Anzahl global blockiert |
| partial_block | Anzahl teilweise blockiert |
| unsubscribe | Anzahl abgemeldet |
| keyword_block | Anzahl blockiert durch Stichwörter |
| variable_error | Anzahl Variablenfehler |
| content_error | Anzahl Inhaltsfehler |
| frequency_overrun | Anzahl Überschreitung der Frequenz |
| other | Sonstige |
Rückgabebeispiel
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}],
"count" : 1
}
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}],
"count" : 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
{
"result" : {
"msg_type" : "2",
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Sende-Fehler
Klassifizierte Statistik gescheiterter Sendungen
URL
https://sms.api.engagelab.cc/v1/stats/send_failed
https://sms.api.engagelab.cc/v1/stats/send_failed
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Anfragemethode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Anfrage-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(sms_user:sms_key) |
Beschreibung der Abfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| time_zone | string | nein | Zeitzone, z. B.: +8 |
| sms_users | string | nein | Statistische Daten für spezifische SMS_USER abrufen, mehrere durch ; getrennt, z. B. sms_users=a;b;c. Bis zu 10 unterstützt |
| start_date | string | ja | Startdatum, Format yyyy-MM-dd |
| end_date | string | ja | Enddatum, Format yyyy-MM-dd |
| msg_type | string | nein | SMS-Typ, 2 steht für internationale SMS |
| label_ids | string | nein | Liste von SMS-Tag-IDs, getrennt durch ;, z. B. label_ids=123456;456789, unterstützt bis zu 10 |
| template_ids | string | nein | Mehrere Template-IDs, getrennt durch ;, z. B. template_ids=1;2;3. Unterstützt bis zu 10 IDs |
| aggregate_by | string | nein | Standardwert ist 0; wenn aggregate=1, werden aggregierte Daten zurückgegeben |
Hinweise:
- Der maximale Abfragezeitraum darf 90 Tage nicht überschreiten.
- Wenn 'aggregate_by' den Wert 1 hat, wird die Datenaggregation nach 'msg_type' durchgeführt; Wenn 'aggregate_by' 0 ist, erfolgt keine Aggregation.
Anfragebeispiel
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung des Rückgabewerts
| Parameter | Beschreibung |
|---|---|
| send_date | Versanddatum |
| label_id | Label-ID |
| msg_type | SMS-Typ |
| sms_user | SMS_USER |
| template_id | SMS-Template-ID |
| empty | Anzahl leer |
| out_of_service | Anzahl außer Betrieb |
| blacklist | Anzahl Blacklist |
| busy | Anzahl besetzt |
| no_answer | Anzahl ohne Antwort |
| interception | Anzahl abgefangene Nachrichten |
| break_down | Anzahl Ausfälle |
| not_in_service | Anzahl nicht erreichbar |
| power_off | Anzahl ausgeschaltet |
| other | Sonstige |
Rückgabebeispiel
aggregate_by=0
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count": 1
}
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
