API de Customer Journey

Obtener estadísticas de Journey

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

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

Autoriza mediante un token de acceso a la API y envía una solicitud vacía al endpoint.

Encabezados

Nombre	Tipo	Descripción
Authorization	string	ID de 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 por su ID. Puedes encontrar el ID de journey en la URL de la página del lienzo del journey:

Autoriza mediante un token de acceso a la API y envía 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 journeys

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

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

Encabezados de la solicitud

Encabezado	Valor
Content-Type	`application/json`
Authorization	`Api <server_api_token>`. Se debe incluir un token de API de servidor válido en el encabezado `Authorization`.

Cuerpo de la solicitud

Envía un objeto JSON con los siguientes campos:

Campo	Tipo	Requerido	Descripción
`user_ids`	`string[]`	Sí	Lista de ID de Usuario para eliminar de los journeys.
`journey_uuids`	`string[]`	Requerido si no se proporciona `all_journeys` o es falso.	Lista de UUID de journeys de los que se eliminarán los usuarios.
`all_journeys`	`boolean`	Requerido si no se proporciona `journey_uuids`.	Si es verdadero, los usuarios serán eliminados de todos los journeys. Si es falso, se debe proporcionar `journey_uuids`.

Nota: Se debe proporcionar al menos uno de all_journeys (establecido en verdadero) o journey_uuids (un 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ás 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"
}