Logo Site EngageLab Mark Colored TransparentDokumentation
MA
Doku-Startseite
ProduktübersichtKonsolenleitfadenREST APIClient SDKDatensicherheitÄnderungsprotokoll
Suchen
Anmelden
REST API/Journey-Statistiken
REST APIJourney-Statistiken...

Journey-Statistiken

Zuletzt aktualisiert：vor 19 Tagen

Abfrage von Statistikdaten, einschließlich „Journey-Zusammenfassungsstatistiken", „Nachrichtenversandstatistiken" und „WebHook-Versandstatistiken".

Journey-Statistiken

Fragt Journey-Daten für Eintritte, Zielkonversionen, vorzeitige Ausstiege, normale Ausstiege und laufende Kontakte ab.

Endpunkt

GET /v1/stats/journey

Authentifizierung

Die EngageLab REST-API verwendet HTTP Basic Authentication. Fügen Sie den Authorization-Header in die HTTP-Anfrage ein:

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}
Diesen Codeblock im schwebenden Fenster anzeigen

Der base64_auth_string wird erzeugt durch: base64(api_key:api_secret)

  • Der Header-Name lautet „Authorization", und der Wert ist das base64-kodierte Paar „username:password" (mit einem Doppelpunkt dazwischen).
  • Im Kontext der MA-API ist der Benutzername der APIKey und das Passwort das APISecret. Sie erhalten den APIKey und das APISecret, indem Sie eine Datenquelle vom Typ API hinzufügen.

Anfragebeispiel

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Feld Typ Erforderlich Beschreibung
journey_id String Ja Journey-ID. Mehrere IDs durch Kommas getrennt, bis zu 100.
time_unit String Ja Zeiteinheit. Werte: HOUR, DAY.
start_time String Ja Startzeit im Format yyyy-MM-dd.
end_time String Ja Endzeit im Format yyyy-MM-dd. Endzeit >= Startzeit. Maximale Zeitspanne: 31 Tage.

Antwortparameter

Feld Typ Beschreibung
code Integer Gibt an, ob der API-Aufruf erfolgreich war. 0 bedeutet Erfolg oder Teilerfolg; andere Werte bedeuten Fehler.
message String Beschreibung des API-Aufrufergebnisses. success bei Erfolg.
data Array<Object> Zurückgegebene Statistikdaten.
journey_id Long Journey-ID.
time_unit String Zeiteinheit. Werte: HOUR, DAY.
error_code Int Gibt an, ob die Journey-Statistiken erfolgreich abgerufen wurden. 0 bedeutet Erfolg; andere Werte bedeuten Fehler.
detail Array<Object> Stündliche/tägliche Details.
time String Statistikdatum in der Antwort, im Format yyyy-MM-dd oder yyyy-MM-dd HH.
entry_count Long Anzahl der Eintritte.
conversion_count Long Anzahl der Konversionen.
completion_count Long Anzahl der normalen Ausstiege.
early_exit_count Long Anzahl der vorzeitigen Ausstiege.
in_progress_count Long Anzahl der laufenden Kontakte, d. h. Kontakte, die sich zum Zeitpunkt der end_time oder time noch in der Journey befanden.

Alle erfolgreich

{ "code": 0, "message": "success", "data": [ { "journey_id":123, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }, { "journey_id":234, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }] }
              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id":123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id":234,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  }]
}
Diesen Codeblock im schwebenden Fenster anzeigen

Alle fehlgeschlagen

{ "code": 50219, "message": "The number of JourneyIDs exceeds 100." }
              
              {
  "code": 50219,
  "message": "The number of JourneyIDs exceeds 100."
}
Diesen Codeblock im schwebenden Fenster anzeigen

Teilerfolg

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }, { "journey_id": -1, "error_code": 50221 }] }
              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id": -1,
      "error_code": 50221
  }]
}
Diesen Codeblock im schwebenden Fenster anzeigen

Nachrichtenversandstatistiken

Fragt Versand-, Zustellungs-, Klick- und andere Daten für jede Nachrichtenkomponente in einer Journey ab.

Endpunkt

GET /v1/stats/journey/message

Anfragebeispiel

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Feld Typ Erforderlich Beschreibung
journey_id String Ja Journey-ID. Mehrere IDs durch Kommas getrennt, bis zu 100.
time_unit String Ja Zeiteinheit. Werte: HOUR, DAY.
start_time String Ja Startzeit im Format yyyy-MM-dd.
end_time String Ja Endzeit im Format yyyy-MM-dd. Endzeit >= Startzeit. Maximale Zeitspanne: 31 Tage.

Antwortparameter

Feld Typ Beschreibung
code Integer Gibt an, ob der API-Aufruf erfolgreich war. 0 bedeutet Erfolg oder Teilerfolg; andere Werte bedeuten Fehler.
message String Beschreibung des API-Aufrufergebnisses. success bei Erfolg.
data Array<Object> Zurückgegebene Statistikdaten.
journey_id Long Journey-ID.
time_unit String Zeiteinheit. Werte: HOUR, DAY.
error_code Int Gibt an, ob die Journey-Statistiken erfolgreich abgerufen wurden. 0 bedeutet Erfolg; andere Werte bedeuten Fehler.
detail Array<Object> Stündliche/tägliche Details.
time String Statistikdatum in der Antwort, im Format yyyy-MM-dd oder yyyy-MM-dd HH.
component_id Long ID der Nachrichtenkomponente.
component_name String Name der Nachrichtenkomponente, z. B. APP_PUSH_1, EMAIL_2.
channel String Kanaltyp.
entry_count Long Anzahl der Eintritte.
plan_count Long Geplante Zielanzahl.
send_count Long Anzahl der Versendungen.
delivery_count Long Anzahl der Zustellungen.
impression_count Long Anzahl der Impressionen.
open_count Long Anzahl der Öffnungen.
click_count Long Anzahl der Klicks.
conversion_count Long Anzahl der Konversionen.
revenue_count Long Anzahl der umsatzgenerierenden Ereignisse.
revenue_amount Number Gesamtumsatzbetrag.

Alle erfolgreich

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-28", "entry_count": 320, "plan_count": 312, "send_count": 290, "delivery_count": 270, "impression_count": 198, "open_count": 155, "click_count": 24, "conversion_count": 8, "revenue_count": 7, "revenue_amount": 488.50 }, { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-29", "entry_count": 305, "plan_count": 298, "send_count": 280, "delivery_count": 261, "impression_count": 185, "open_count": 144, "click_count": 19, "conversion_count": 6, "revenue_count": 5, "revenue_amount": 312.00 } ] } ] }
              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-28",
        "entry_count": 320,
        "plan_count": 312,
        "send_count": 290,
        "delivery_count": 270,
        "impression_count": 198,
        "open_count": 155,
        "click_count": 24,
        "conversion_count": 8,
        "revenue_count": 7,
        "revenue_amount": 488.50
      },
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-29",
        "entry_count": 305,
        "plan_count": 298,
        "send_count": 280,
        "delivery_count": 261,
        "impression_count": 185,
        "open_count": 144,
        "click_count": 19,
        "conversion_count": 6,
        "revenue_count": 5,
        "revenue_amount": 312.00
      }
    ]
  }
]
}
Diesen Codeblock im schwebenden Fenster anzeigen

WebHook-Versandstatistiken

Fragt Anfrage- und Erfolgsdaten für jede WebHook-Komponente in einer Journey ab.

Endpunkt

GET /v1/stats/journey/webhook

Anfragebeispiel

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Feld Typ Erforderlich Beschreibung
journey_id String Ja Journey-ID. Mehrere IDs durch Kommas getrennt, bis zu 100.
time_unit String Ja Zeiteinheit. Werte: HOUR, DAY.
start_time String Ja Startzeit im Format yyyy-MM-dd.
end_time String Ja Endzeit im Format yyyy-MM-dd. Endzeit >= Startzeit. Maximale Zeitspanne: 31 Tage.

Antwortparameter

Feld Typ Beschreibung
code Integer Gibt an, ob der API-Aufruf erfolgreich war. 0 bedeutet Erfolg oder Teilerfolg; andere Werte bedeuten Fehler.
message String Beschreibung des API-Aufrufergebnisses. success bei Erfolg.
data Array<Object> Zurückgegebene Statistikdaten.
journey_id Long Journey-ID.
time_unit String Zeiteinheit. Werte: HOUR, DAY.
error_code Int Gibt an, ob die Journey-Statistiken erfolgreich abgerufen wurden. 0 bedeutet Erfolg; andere Werte bedeuten Fehler.
detail Array<Object> Stündliche/tägliche Details.
time String Statistikdatum in der Antwort, im Format yyyy-MM-dd oder yyyy-MM-dd HH.
component_id Long ID der Nachrichtenkomponente.
component_name String Name der Nachrichtenkomponente, z. B. APP_PUSH_1, EMAIL_2.
entry_count Long Anzahl der Eintritte in die WebHook-Komponente.
send_count Long Anzahl der erfolgreichen Anfragen.
send_failure_count Long Anzahl der fehlgeschlagenen Anfragen.

Alle erfolgreich

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-28", "entry_count": 520, "send_count": 498, "send_failure_count": 22 }, { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-29", "entry_count": 610, "send_count": 600, "send_failure_count": 10 } ] } ] }
              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-28",
        "entry_count": 520,
        "send_count": 498,
        "send_failure_count": 22
      },
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-29",
        "entry_count": 610,
        "send_count": 600,
        "send_failure_count": 10
      }
    ]
  }
]
}
Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Allgemeine Fehlercodes

HTTP-Status code message Beschreibung
401 40050 authorization invalid Authentifizierung fehlgeschlagen.
429 55110 Too many requests, please try again later. Ratenlimit überschritten.
400 40001 http参数不合法 Ungültige HTTP-Nachricht oder fehlender Pfad-/Abfrageparameter.
400 40002 业务参数不合法 Validierung des Parameterformats, Aufzählungswerts oder Typs fehlgeschlagen.
400 50034 项目不存在 Das mit dem APIKey verknüpfte Projekt existiert nicht.
500 -1 服务器内部错误 Interner Serverfehler.

Journey-Statistik-Fehlercodes

HTTP-Status code message Beschreibung
400 50202 Journey does not exist. Die Journey existiert nicht oder gehört nicht zum aktuellen Projekt.
400 50217 Invalid time range. start_time > end_time oder der Abfragezeitraum überschreitet 31 Tage.
400 50219 The number of JourneyIDs exceeds 100. Die Anzahl der JourneyIDs überschreitet das Limit von 100.
400 50220 Invalid time_unit. Ungültiger Wert für time_unit; nur HOUR und DAY werden unterstützt.
400 50221 Invalid journey_id format. Ungültiges Format einer einzelnen JourneyID (Feld error_code, zeigt an, dass eine bestimmte Journey-Abfrage fehlgeschlagen ist).
Icon Solid Transparent White Qiyu
Vertrieb kontaktieren