Estatísticas de in-app

Dois métodos retornam estatísticas para campanhas de in-app instantâneas. Use inapps:totals para totais do período em uma ou mais campanhas, e inapps:timeline para uma série temporal de uma única campanha. Os valores correspondem à tela de estatísticas de in-app no Painel de Controle.

In-apps enviados de uma Journey

Esses métodos cobrem apenas campanhas de in-app instantâneas. In-apps entregues por um elemento de Customer Journey são relatados por ponto da jornada por Obter estatísticas da Journey.

Métricas

Campo	Tipo	Descrição
impressions	número	Quantas vezes o in-app foi exibido. Rotulado como Impressões no Painel de Controle.
unique_impressions	número	Número de dispositivos únicos para os quais o in-app foi exibido.
interactions	número	Interações com o conteúdo do in-app: cliques em botões, cliques em links e envios de formulários.
unique_interactions	número	Número de dispositivos únicos que interagiram com o in-app.
skips	número	Quantas vezes os usuários dispensaram o in-app sem interagir.
audience	número	Número de dispositivos únicos que produziram qualquer evento de in-app no período.

Nota

Métricas únicas e audience são aproximadas porque usam uma contagem distinta probabilística. Os números da plataforma não somam o total da campanha: um dispositivo que aparece em duas plataformas é contado uma vez em cada detalhamento da plataforma e uma vez no total da campanha.

inapps:totals

Retorna os totais do período. Passe inapp_codes para relatar campanhas específicas, ou omita-o para percorrer cada in-app do aplicativo página por página. Esse é o método a ser usado para uma exportação agendada.

POST https://api.pushwoosh.com/api/v2/statistics/inapps:totals

Cabeçalhos

Nome	Obrigatório	Descrição
Authorization	Sim	Token da API do servidor no formato Authorization: Api <Server Key>.

Parâmetros do corpo da solicitação

Nome	Obrigatório	Tipo	Descrição
application	Sim	String	Código do aplicativo.
date_range	Sim	Objeto	Período do relatório. date_from e date_to usam o formato YYYY-MM-DD e são inclusivos. O período é contado em UTC e não deve exceder 366 dias.
inapp_codes	Não	Array	Códigos de in-app, até 100 por solicitação. Omita para relatar todos os in-apps do aplicativo. Se algum código na lista não pertencer ao aplicativo, a solicitação inteira falhará com 404.
platforms	Não	Array	Restrinja as métricas a estas plataformas. Valores possíveis: "IOS", "ANDROID", "HUAWEI_ANDROID", "AMAZON", "OSX", "WINDOWS", "SAFARI", "CHROME", "FIREFOX", "WEB".
with_platforms	Não	Booleano	Adicione um detalhamento por plataforma a cada item.
page	Não	Inteiro	Número da página, começando em 0. Aplica-se quando inapp_codes é omitido.
per_page	Não	Inteiro	Itens por página, 20 por padrão, 100 no máximo.

Exemplo de solicitação

curl -X POST https://api.pushwoosh.com/api/v2/statistics/inapps:totals \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "XXXXX-XXXXX",
    "date_range": {
      "date_from": "2026-07-01",
      "date_to": "2026-07-31"
    },
    "inapp_codes": ["AAAAA-BBBBB"],
    "with_platforms": true
  }'

Campos da resposta

total é o número de in-apps que a solicitação corresponde. Quando inapp_codes é omitido, isso representa todos os in-apps do aplicativo, então a paginação pode percorrê-lo. items contém a página atual. page conta a partir de 0.

Exemplo de resposta

{
  "total": 1,
  "page": 0,
  "per_page": 20,
  "items": [{
    "inapp": {
      "code": "AAAAA-BBBBB",
      "name": "Summer sale",
      "status": "active",
      "rich_media_code": "CCCCC-DDDDD"
    },
    "metrics": {
      "impressions": 15230,
      "unique_impressions": 9120,
      "interactions": 2311,
      "unique_interactions": 1980,
      "skips": 640,
      "audience": 9120
    },
    "platforms": [{
      "platform": "IOS",
      "metrics": {
        "impressions": 8100,
        "unique_impressions": 4900,
        "interactions": 1300,
        "unique_interactions": 1120,
        "skips": 310,
        "audience": 4900
      }
    }],
    "frequency_capping": {
      "suppressions": 45,
      "affected_users": 30,
      "data_available_from": "2026-07-17"
    }
  }]
}

inapps:timeline

Retorna os totais do período e uma série temporal para uma campanha de in-app.

POST https://api.pushwoosh.com/api/v2/statistics/inapps:timeline

Parâmetros do corpo da solicitação

Nome	Obrigatório	Tipo	Descrição
application	Sim	String	Código do aplicativo.
inapp_code	Sim	String	Código do in-app.
date_range	Sim	Objeto	Período do relatório. date_from e date_to usam o formato YYYY-MM-DD e são inclusivos. O período é contado em UTC e não deve exceder 366 dias. interval opcional: "HOUR", "DAY" (padrão), "WEEK" ou "MONTH". "HOUR" está disponível para períodos de até 31 dias.
platforms	Não	Array	Restrinja as métricas a estas plataformas.
with_platforms	Não	Booleano	Adicione um detalhamento por plataforma aos totais e a cada linha.

Exemplo de solicitação

curl -X POST https://api.pushwoosh.com/api/v2/statistics/inapps:timeline \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "XXXXX-XXXXX",
    "inapp_code": "AAAAA-BBBBB",
    "date_range": {
      "date_from": "2026-07-01",
      "date_to": "2026-07-07",
      "interval": "DAY"
    }
  }'

Exemplo de resposta

{
  "inapp": {
    "code": "AAAAA-BBBBB",
    "name": "Summer sale",
    "status": "active",
    "rich_media_code": "CCCCC-DDDDD"
  },
  "totals": {
    "impressions": 15230,
    "unique_impressions": 9120,
    "interactions": 2311,
    "unique_interactions": 1980,
    "skips": 640,
    "audience": 9120
  },
  "frequency_capping": {
    "suppressions": 45,
    "affected_users": 30,
    "data_available_from": "2026-07-17"
  },
  "rows": [{
    "timestamp": "2026-07-01T00:00:00Z",
    "metrics": {
      "impressions": 2140,
      "unique_impressions": 1700,
      "interactions": 320,
      "unique_interactions": 290,
      "skips": 95,
      "audience": 1700
    }
  }],
  "impression_duration": [
    { "from_seconds": 0, "to_seconds": 5, "count": 3200 },
    { "from_seconds": 5, "to_seconds": 15, "count": 5400 },
    { "from_seconds": 15, "to_seconds": 30, "count": 4100 },
    { "from_seconds": 30, "to_seconds": 0, "count": 2530 }
  ]
}

impression_duration agrupa por quanto tempo o in-app permaneceu na tela. No último grupo, to_seconds é 0, o que significa “30 segundos ou mais”.

Limite de frequência

O bloco frequency_capping relata as exibições de in-app que o limite de frequência impediu, e o número de usuários únicos afetados. As supressões não são contadas em impressions.

Os dados de supressão começam em 17 de julho de 2026

As supressões não foram registradas antes dessa data. Para um período que termina antes, o bloco frequency_capping retorna como null em vez de zeros, para que a falta de dados nunca seja confundida com um limite que não suprimiu nada. data_available_from na resposta indica o primeiro dia coberto. O limite de frequência não tem um detalhamento por plataforma.

Retenção de dados

As estatísticas são mantidas por 365 dias, portanto, um período que começa antes não retorna dados para os dias não cobertos.

Códigos de resposta

Código	Significado
200	Sucesso.
400	Solicitação inválida: um date_range ausente ou malformado, um período maior que 366 dias, um intervalo de hora em mais de 31 dias, ou mais de 100 inapp_codes.
401	Token de API ausente ou inválido.
404	Um código de in-app não foi encontrado neste aplicativo.