Statistiques in-app

Deux méthodes renvoient des statistiques pour les campagnes in-app instantanées. Utilisez inapps:totals pour les totaux de la période sur une ou plusieurs campagnes, et inapps:timeline pour une série chronologique d’une seule campagne. Les valeurs correspondent à l’écran des statistiques in-app dans le Panneau de Configuration.

In-apps envoyés depuis un Journey

Ces méthodes ne couvrent que les campagnes in-app instantanées. Les in-apps délivrés par un élément Customer Journey sont rapportés par point de parcours par Get Journey stats.

Métriques

Champ	Type	Description
impressions	number	Combien de fois l’in-app a été affiché. Étiqueté Impressions dans le Panneau de Configuration.
unique_impressions	number	Nombre d’appareils uniques sur lesquels l’in-app a été affiché.
interactions	number	Interactions avec le contenu de l’in-app : clics sur les boutons, clics sur les liens et soumissions de formulaires.
unique_interactions	number	Nombre d’appareils uniques qui ont interagi avec l’in-app.
skips	number	Combien de fois les utilisateurs ont fermé l’in-app sans interagir.
audience	number	Nombre d’appareils uniques qui ont produit un événement in-app au cours de la période.

Note

Les métriques uniques et l’ audience sont approximatives car elles utilisent un décompte probabiliste des éléments distincts. Les chiffres par plateforme ne s’additionnent pas au total de la campagne : un appareil qui apparaît sur deux plateformes est compté une fois dans chaque répartition par plateforme et une fois dans le total de la campagne.

inapps:totals

Renvoie les totaux pour la période. Passez inapp_codes pour rapporter sur des campagnes spécifiques, ou omettez-le pour parcourir chaque in-app de l’application page par page. C’est la méthode à utiliser pour un export planifié.

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

En-têtes

Nom	Requis	Description
Authorization	Oui	Jeton d’API serveur au format Authorization: Api <Server Key>.

Paramètres du corps de la requête

Nom	Requis	Type	Description
application	Oui	String	Code d’application.
date_range	Oui	Object	Période de rapport. date_from et date_to utilisent le format YYYY-MM-DD et sont inclusifs. La période est comptée en UTC et ne doit pas dépasser 366 jours.
inapp_codes	Non	Array	Codes in-app, jusqu’à 100 par requête. Omettez pour rapporter sur tous les in-apps de l’application. Si un code de la liste n’appartient pas à l’application, la requête entière échoue avec un code 404.
platforms	Non	Array	Restreindre les métriques à ces plateformes. Valeurs possibles : "IOS", "ANDROID", "HUAWEI_ANDROID", "AMAZON", "OSX", "WINDOWS", "SAFARI", "CHROME", "FIREFOX", "WEB".
with_platforms	Non	Boolean	Ajouter une répartition par plateforme à chaque élément.
page	Non	Integer	Numéro de page, commençant à 0. S’applique lorsque inapp_codes est omis.
per_page	Non	Integer	Éléments par page, 20 par défaut, 100 au maximum.

Exemple de requête

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

Champs de la réponse

total est le nombre d’in-apps correspondant à la requête. Lorsque inapp_codes est omis, il s’agit de tous les in-apps de l’application, la pagination peut donc la parcourir. items contient la page actuelle. page compte à partir de 0.

Exemple de réponse

{
  "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

Renvoie les totaux de la période et une série chronologique pour une campagne in-app.

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

Paramètres du corps de la requête

Nom	Requis	Type	Description
application	Oui	String	Code d’application.
inapp_code	Oui	String	Code in-app.
date_range	Oui	Object	Période de rapport. date_from et date_to utilisent le format YYYY-MM-DD et sont inclusifs. La période est comptée en UTC et ne doit pas dépasser 366 jours. interval optionnel : "HOUR", "DAY" (par défaut), "WEEK" ou "MONTH". "HOUR" est disponible pour les périodes allant jusqu’à 31 jours.
platforms	Non	Array	Restreindre les métriques à ces plateformes.
with_platforms	Non	Boolean	Ajouter une répartition par plateforme aux totaux et à chaque ligne.

Exemple de requête

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"
    }
  }'

Exemple de réponse

{
  "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 regroupe la durée pendant laquelle l’in-app est resté à l’écran. Dans le dernier groupe, to_seconds est 0, ce qui signifie “30 secondes et plus”.

Limitation de fréquence

Le bloc frequency_capping rapporte les affichages in-app que la limitation de fréquence a empêchés, ainsi que le nombre d’utilisateurs uniques affectés. Les suppressions ne sont pas comptées dans les impressions.

Les données de suppression commencent le 17 juillet 2026

Les suppressions n’étaient pas enregistrées avant cette date. Pour une période se terminant plus tôt, le bloc frequency_capping revient en tant que null au lieu de zéros, de sorte qu’un manque de données n’est jamais confondu avec une limitation qui n’a rien supprimé. data_available_from dans la réponse indique le premier jour couvert. La limitation de fréquence n’a pas de répartition par plateforme.

Rétention des données

Les statistiques sont conservées pendant 365 jours, donc une période qui commence plus tôt ne renvoie aucune donnée pour les jours non couverts.

Codes de réponse

Code	Signification
200	Succès.
400	Requête invalide : un date_range manquant ou malformé, une période de plus de 366 jours, un intervalle horaire sur plus de 31 jours, ou plus de 100 inapp_codes.
401	Jeton d’API manquant ou invalide.
404	Un code in-app n’a pas été trouvé dans cette application.