API Customer Journey

Obtenir les statistiques de parcours

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

Obtient les statistiques pour un parcours spécifique via son ID. Vous pouvez trouver l’ID du parcours dans l’URL de la page du canvas de parcours (voir l’image ci-dessous).

Autorisez via le jeton d’accès API et envoyez une requête vide au point de terminaison.

En-têtes

Nom	Type	Description
Authorization	string	ID de parcours

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
      }
    }]
  }
}

Obtient les statistiques pour un parcours spécifique via son ID. Vous pouvez trouver l’ID de parcours dans l’URL de la page du canvas de parcours :

Autorisez via le jeton d’accès API et envoyez une requête vide au point de terminaison.

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
      }
    }]
  }
}

Supprimer des utilisateurs des parcours

Ce point de terminaison vous permet de supprimer une liste d’utilisateurs de tous les parcours actifs ou de parcours spécifiques.

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

En-têtes de requête

En-tête	Valeur
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`. Un jeton d’authentification valide doit être inclus dans l’en-tête `Authorization`.

Corps de la requête

Envoyez un objet JSON avec les champs suivants :

Champ	Type	Requis	Description
`user_ids`	`string[]`	Oui	Liste des ID utilisateur à supprimer des parcours.
`journey_uuids`	`string[]`	Requis si `all_journeys` n’est pas fourni ou est false.	Liste des UUID de parcours dont les utilisateurs doivent être supprimés.
`all_journeys`	`boolean`	Requis si `journey_uuids` n’est pas fourni.	Si true, les utilisateurs seront supprimés de tous les parcours. Si false, `journey_uuids` doit être fourni.

Note : Au moins l’un des paramètres all_journeys (défini sur true) ou journey_uuids (tableau non vide) doit être fourni.

Exemples de requête

Supprimer les utilisateurs de tous les parcours

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

Supprimer les utilisateurs de parcours spécifiques

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

{
  "success": true
}

Si la requête est invalide, vous recevrez une erreur 400 avec un message descriptif.

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

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