API de Customer Journey

Obtener estadísticas del Journey

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

Obtiene estadísticas para un journey específico mediante su ID. Puede encontrar el ID del journey en la URL de la página del lienzo del journey (vea la imagen a continuación).

Autorice mediante el token de acceso a la API y envíe una solicitud vacía al endpoint.

Encabezados

Nombre	Tipo	Descripción
Authorization	string	ID del Journey

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

Obtiene estadísticas para un journey específico mediante su ID. Puede encontrar el ID del journey en la URL de la página del lienzo del journey:

Autorice mediante el token de acceso a la API y envíe una solicitud vacía al endpoint.

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

Eliminar usuarios de los journeys

Este endpoint le permite eliminar una lista de usuarios de todos los journeys activos o de algunos específicos.

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

Encabezados de solicitud

Encabezado	Valor
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`. Se debe incluir un token de autenticación válido en el encabezado `Authorization`.

Cuerpo de la solicitud

Envíe un objeto JSON con los siguientes campos:

Campo	Tipo	Obligatorio	Descripción
`user_ids`	`string[]`	Sí	Lista de IDs de Usuario para eliminar de los journeys.
`journey_uuids`	`string[]`	Requerido si `all_journeys` no se proporciona o es false.	Lista de UUIDs de journey de los cuales eliminar usuarios.
`all_journeys`	`boolean`	Requerido si `journey_uuids` no se proporciona.	Si es true, los usuarios serán eliminados de todos los journeys. Si es false, se debe proporcionar `journey_uuids`.

Nota: Se debe proporcionar al menos uno de all_journeys (establecido en true) o journey_uuids (array no vacío).

Ejemplos de solicitud

Eliminar usuarios de todos los journeys

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

Eliminar usuarios de journeys específicos

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

{
  "success": true
}

Si la solicitud no es válida, recibirá un error 400 con un mensaje descriptivo.

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

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