Estatísticas de aplicativos e assinantes

getAppStats

Obtenha as estatísticas de um aplicativo específico para um período de tempo definido.

POST https://api.pushwoosh.com/json/1.3/getAppStats

Parâmetros do corpo da solicitação

Nome	Obrigatório	Tipo	Descrição
`auth`	Sim	string	Token de acesso à API do Painel de Controle Pushwoosh.
`application`	Sim	string	Código do aplicativo Pushwoosh
`datefrom`	Sim	string	Data e hora de início do período do relatório. Formato: `Y-m-d H:i:s`.
`dateto`	Sim	string	Data e hora de término do período do relatório. Formato: `Y-m-d H:i:s`.

Exemplo de solicitação

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",    // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "application": "XXXXX-XXXXX",      // obrigatório. Código do aplicativo Pushwoosh
    "datefrom": "2013-06-04 00:00:00", // obrigatório. Data e hora, início do período do relatório
    "dateto": "2013-06-07 00:00:00"    // obrigatório. Data e hora, fim do período do relatório
  }
}

Exemplo de resposta

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "request_id": "c93a202f439235f9adaaa06d651548ab"
  }
}

Entendendo as estatísticas

As estatísticas exibem ações registradas para um aplicativo, dispositivo ou mensagem dentro do período de tempo especificado.

Os relatórios são agregados automaticamente usando as seguintes regras:

Anual: Se o período for maior que um ano.
Mensal: Se o período for maior que um mês.
Diário: Se o período for maior que um dia.
Por hora: Se o período for maior que três horas.
Por minuto: Em todos os outros casos.

Tipos de ação

Nível do Aplicativo: _open_, _install_
Nível do Dispositivo: _register_, _unregister_
Nível da Mensagem: _send_, _open_

Formato da resposta

Todos os objetos de estatísticas têm o mesmo formato:

Campo	Tipo	Descrição
`formatter`	string	Escala do relatório: anual, mensal, diário, por hora, por minuto.
`rows`	list	Contém dados do relatório para cada ação registrada.

Cada linha do relatório contém:

Campo	Tipo	Descrição
`count`	int	Número de ações registradas.
`action`	string	O tipo de ação registrada.
`datetime`	string	Data formatada: `Y-m-d H:i:s`.

Recuperando resultados de solicitações agendadas

Corpo da resposta

Campo	Tipo	Descrição
`request_id`	string	ID da solicitação agendada. Consulte `/getResults` para mais detalhes.

Corpo da resposta agendada (/getResults)

Campo	Tipo	Descrição
`applications`	dictionary	Estatísticas para aplicativos.
`devices`	dictionary	Estatísticas para dispositivos.
`messages`	dictionary	Estatísticas para mensagens.

Exemplo

{
  "error": {
    "code": 0,
    "message": "OK"
  },
  "json_data": {
    "applications": {
      "formatter": "hourly",
      "rows": [{
        "count": 0,
        "action": "open",
        "datetime": "2013-06-06 00:00:00"
      }, {
        ...
      }]
    }
  }
}

getApplicationSubscribersStats

Exibe a lista de assinantes do aplicativo agrupada pelos tipos de seus dispositivos.

POST https://api.pushwoosh.com/json/1.3/getApplicationSubscribersStats

Corpo da Solicitação

Nome	Obrigatório	Tipo	Descrição
`auth`	Sim	string	Token de acesso à API do Painel de Controle Pushwoosh.
`application`	Sim	string	Código do aplicativo Pushwoosh

Exemplo de solicitação

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "application": "XXXXX-XXXXX"    // obrigatório. Código do aplicativo Pushwoosh
  }
}

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "IOS": 1,
    "ANDROID": 1,
    "OSX": 0,
    "WINDOWS": 0,
    "AMAZON": 0,
    "SAFARI": 0,
    "FIREFOX": 0
  }
}

getSubscribersStatistics

Recupera as estatísticas de assinantes do aplicativo para um período de tempo.

POST https://api.pushwoosh.com/api/v2/statistics/application/getSubscribersStatistics

Cabeçalhos

Nome	Obrigatório	Descrição
Authorization	Sim	Token de acesso à API no formato: `Key PKX.......NHg`.
Content-Type	Sim	Deve ser definido como `application/json`.

Parâmetros do corpo da solicitação

Nome	Obrigatório	Tipo	Descrição
application_code	Sim	string	Código do aplicativo Pushwoosh
timestamp_from	Sim	string	Data e hora de início do período de estatísticas (formato: `YYYY-MM-DD hh:mm:ss`, UTC+0).
timestamp_to	Sim	string	Data e hora de término do período de estatísticas (formato: `YYYY-MM-DD hh:mm:ss`, UTC+0).

Exemplo de solicitação

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/application/getSubscribersStatistics' \
--header 'Authorization: Key 3a2X......828JreCk48f' \
--header 'Content-Type: application/json' \
--data-raw '{
   "application_code": "12345-67890",        // Código do aplicativo Pushwoosh
   "timestamp_from": "2022-08-01 00:00:00",  // UTC+0
   "timestamp_to": "2022-09-01 00:00:00"     // UTC+0
}'

Exemplo de resposta

{
  "statistics": [{
    "timestamp": "YYYY-MM-DD hh:mm:ss", // UTC+0
    "platform": 1,
    "push_enabled": 100,
    "push_disabled": 100
  }]
}

Códigos de resposta

{
  "statistics": [{
    "timestamp": "YYYY-MM-DD hh:mm:ss",
    "platform": 1,
    "push_enabled": 100,
    "push_disabled": 100
  }]
}

Explicação: A solicitação foi bem-sucedida e as estatísticas são retornadas.

{
  // Resposta
}

Explicação: A solicitação tinha sintaxe ou parâmetros inválidos.

{
  // Resposta
}

Explicação: O servidor encontrou um erro. Tente novamente mais tarde.

{
  // Resposta
}

Explicação: A autenticação falhou. Verifique sua chave de API ou token.

{
  // Resposta
}

Explicação: Acesso negado para o código do aplicativo especificado.

{
  // Resposta
}

Explicação: O código do aplicativo não foi encontrado ou não existe.

Regras de intervalo de timestamp

Período solicitado	Intervalo na resposta
Mais de 1 ano	1 ano
1 ano	1 mês
1 mês - 1 ano	1 dia
Menos de 1 mês	1 hora