Customer Journey API

Journey-Statistiken abrufen

GET https://journey.pushwoosh.com/api/journey/{id}/statistics/external

Ruft Statistiken für eine bestimmte Journey anhand ihrer ID ab. Sie finden die Journey-ID in der URL der Journey-Canvas-Seite (siehe Bild unten).

Autorisieren Sie sich mit dem API-Zugriffstoken und senden Sie eine leere Anfrage an den Endpunkt.

Name	Typ	Beschreibung
Authorization	string	Journey-ID

200: OK

{
  "payload": {
    "title": "Journey Title",
    "points": [{
      "pointTitle": "First Point Title",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "sent": 22648,
        "opened": 60,
        "uniqOpened": 60,
        "conversion": 0.26492405510420347
      }
    }]
  }
}

Ruft Statistiken für eine bestimmte Journey anhand ihrer ID ab. Sie finden die Journey-ID in der URL der Journey-Canvas-Seite:

Autorisieren Sie sich mit dem API-Zugriffstoken und senden Sie eine leere Anfrage an den Endpunkt.

curl --location --request GET 'https://journey.pushwoosh.com/api/journey/<journey_id>/statistics/external' \
--header 'Authorization: Api <YOUR API TOKEN>'

{
  "payload": {
    "title": "Journey Title",
    "points": [{
      "pointTitle": "First Point Title",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "sent": 22648,
        "opened": 60,
        "uniqOpened": 60,
        "conversion": 0.26492405510420347
      }
    }]
  }
}

Benutzer aus Journeys entfernen

Dieser Endpunkt ermöglicht es Ihnen, eine Liste von Benutzern aus allen oder bestimmten aktiven Journeys zu entfernen.

POST https://journey.pushwoosh.com/api/journey/drop-users/external

Anfrage-Header

Header	Wert
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`. Ein gültiges Authentifizierungstoken muss im `Authorization`-Header enthalten sein.

Anfrage-Body

Senden Sie ein JSON-Objekt mit den folgenden Feldern:

Feld	Typ	Erforderlich	Beschreibung
`user_ids`	`string[]`	Ja	Liste der Benutzer-IDs, die aus Journeys entfernt werden sollen.
`journey_uuids`	`string[]`	Erforderlich, wenn `all_journeys` nicht angegeben oder false ist.	Liste der Journey-UUIDs, aus denen Benutzer entfernt werden sollen.
`all_journeys`	`boolean`	Erforderlich, wenn `journey_uuids` nicht angegeben ist.	Wenn true, werden Benutzer aus allen Journeys entfernt. Wenn false, muss `journey_uuids` angegeben werden.

Hinweis: Mindestens eines von all_journeys (auf true gesetzt) oder journey_uuids (nicht leeres Array) muss angegeben werden.

Anfrage-Beispiele

Benutzer aus allen Journeys entfernen

{
  "user_ids": ["user1", "user2", "user3"],
  "all_journeys": true
}

Benutzer aus bestimmten Journeys entfernen

{
  "user_ids": ["user1", "user2"],
  "journey_uuids": ["journey-uuid-1", "journey-uuid-2"]
}

{
  "success": true
}

Wenn die Anfrage ungültig ist, erhalten Sie einen 400-Fehler mit einer beschreibenden Nachricht.

{
  "success": false,
  "message": "user_ids must be provided"
}

{
  "success": false,
  "message": "journey_uuids must be provided if all_journeys is false"
}