API da Customer Journey

Obter estatísticas da Journey

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

Obtém estatísticas para uma jornada específica pelo seu ID. Você pode encontrar o ID da jornada na URL da página da tela da jornada (veja a imagem abaixo).

Autorize com o token de acesso da API e envie uma solicitação vazia para o endpoint.

Cabeçalhos

Nome	Tipo	Descrição
Authorization	string	ID da 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
      }
    }]
  }
}

Obtém estatísticas para uma jornada específica pelo seu ID. Você pode encontrar o ID da jornada na URL da página da tela da jornada:

Autorize com o token de acesso da API e envie uma solicitação vazia para o 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
      }
    }]
  }
}

Remover usuários de jornadas

Este endpoint permite que você remova uma lista de usuários de todas ou de jornadas ativas específicas.

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

Cabeçalhos da solicitação

Cabeçalho	Valor
Content-Type	`application/json`
Authorization	`Api <server_api_token>`. Um token de API do servidor válido deve ser incluído no cabeçalho `Authorization`.

Corpo da solicitação

Envie um objeto JSON com os seguintes campos:

Campo	Tipo	Obrigatório	Descrição
`user_ids`	`string[]`	Sim	Lista de IDs de Usuário para remover das jornadas.
`journey_uuids`	`string[]`	Obrigatório se `all_journeys` não for fornecido ou for falso.	Lista de UUIDs de jornada dos quais remover os usuários.
`all_journeys`	`boolean`	Obrigatório se `journey_uuids` não for fornecido.	Se verdadeiro, os usuários serão removidos de todas as jornadas. Se falso, `journey_uuids` deve ser fornecido.

Nota: Pelo menos um dos campos all_journeys (definido como verdadeiro) ou journey_uuids (array não vazio) deve ser fornecido.

Exemplos de solicitação

Remover usuários de todas as jornadas

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

Remover usuários de jornadas específicas

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

{
  "success": true
}

Se a solicitação for inválida, você receberá um erro 400 com uma mensagem descritiva.

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

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