Statistiques de l'application et des abonnés
getAppStats
Anchor link toObtenez les statistiques d’une application spécifique pour une période définie.
POST
https://cp.pushwoosh.com/json/1.3/getAppStats
Paramètres de la requête
Anchor link toNom | Requis | Type | Description |
---|---|---|---|
auth | Oui | string | Jeton d’accès API depuis le Panneau de contrôle Pushwoosh. |
application | Oui | string | Code d’application Pushwoosh |
datefrom | Oui | string | Date et heure de début de la période de reporting. Format : Y-m-d H:i:s . |
dateto | Oui | string | Date et heure de fin de la période de reporting. Format : Y-m-d H:i:s . |
Exemple de requête
Anchor link to{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Panneau de contrôle Pushwoosh "application": "XXXXX-XXXXX", // requis. Code d'application Pushwoosh "datefrom": "2013-06-04 00:00:00", // requis. Date et heure, début de la période de reporting "dateto": "2013-06-07 00:00:00" // requis. Date et heure, fin de la période de reporting }}
Exemple de réponse
Anchor link to{ "status_code": 200, "status_message": "OK", "response": { "request_id": "c93a202f439235f9adaaa06d651548ab" }}
Comprendre les statistiques
Anchor link toLes statistiques affichent les actions enregistrées pour une application, un appareil ou un message dans le laps de temps spécifié.
Les rapports sont automatiquement agrégés en utilisant les règles suivantes :
- Annuel : Si la période est supérieure à un an.
- Mensuel : Si la période est supérieure à un mois.
- Quotidien : Si la période est supérieure à un jour.
- Horaire : Si la période est supérieure à trois heures.
- Par minute : Dans tous les autres cas.
Types d’action
Anchor link to- Niveau Application :
_open_
,_install_
- Niveau Appareil :
_register_
,_unregister_
- Niveau Message :
_send_
,_open_
Format de réponse
Anchor link toTous les objets de statistiques ont le même format :
Champ | Type | Description |
---|---|---|
formatter | string | Échelle du rapport : annuel, mensuel, quotidien, horaire, par minute. |
rows | list | Contient les données du rapport pour chaque action enregistrée. |
Chaque ligne du rapport contient :
Champ | Type | Description |
---|---|---|
count | int | Nombre d’actions enregistrées. |
action | string | Le type d’action enregistrée. |
datetime | string | Date formatée : Y-m-d H:i:s . |
Récupération des résultats de la requête planifiée
Anchor link toCorps de la réponse
Anchor link toChamp | Type | Description |
---|---|---|
request_id | string | ID de la requête planifiée. Référez-vous à /getResults pour plus de détails. |
Corps de la réponse planifiée (/getResults)
Anchor link toChamp | Type | Description |
---|---|---|
applications | dictionary | Statistiques pour les applications. |
devices | dictionary | Statistiques pour les appareils. |
messages | dictionary | Statistiques pour les messages. |
Exemple
Anchor link to{ "error": { "code": 0, "message": "OK" }, "json_data": { "applications": { "formatter": "hourly", "rows": [{ "count": 0, "action": "open", "datetime": "2013-06-06 00:00:00" }, { ... }] } }}
getApplicationSubscribersStats
Anchor link toAffiche la liste des abonnés de l’application, regroupée par type d’appareil.
POST
https://api.pushwoosh.com/json/1.3/getApplicationSubscribersStats
Corps de la requête
Anchor link toNom | Requis | Type | Description |
---|---|---|---|
auth | Oui | string | Jeton d’accès API depuis le Panneau de contrôle Pushwoosh. |
application | Oui | string | Code d’application Pushwoosh |
Exemple de requête
{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Panneau de contrôle Pushwoosh "application": "XXXXX-XXXXX" // requis. Code d'application Pushwoosh }}
{ "status_code": 200, "status_message": "OK", "response": { "IOS": 1, "ANDROID": 1, "OSX": 0, "WINDOWS": 0, "AMAZON": 0, "SAFARI": 0, "FIREFOX": 0 }}
getSubscribersStatistics
Anchor link toRécupère les statistiques des abonnés de l’application pour une période donnée.
POST
https://api.pushwoosh.com/api/v2/statistics/application/getSubscribersStatistics
En-têtes
Anchor link to| Nom
| Requis | Type | Description ||-----------------|----------|--------|--------------------------------------------------------------------------------------------------------------|
| Authorization | Oui | string | Jeton d’accès API au format :
Key PKX.......NHg
. || Content-Type | Oui | string | Doit être défini sur
application/json
. |Paramètres de la requête
Anchor link to| Nom
| Requis | Type | Description ||------------------|----------|--------|--------------------------------------------------------------------------|
| application_code | Oui | string | Code d’application Pushwoosh |
| timestamp_from | Oui | string | Date et heure de début de la période de statistiques (format :
YYYY-MM-DD hh:mm:ss
, UTC+0). || timestamp_to | Oui | string | Date et heure de fin de la période de statistiques (format :
YYYY-MM-DD hh:mm:ss
, UTC+0). |Exemple de requête
curl --location --request POST 'https://go.pushwoosh.com/api/v2/statistics/application/getSubscribersStatistics' \--header 'Authorization: Key 3a2X......828JreCk48f' \--header 'Content-Type: application/json' \--data-raw '{ "application_code": "12345-67890", // Code d'application Pushwoosh "timestamp_from": "2022-08-01 00:00:00", // UTC+0 "timestamp_to": "2022-09-01 00:00:00" // UTC+0}'
Exemple de réponse
{ "statistics": [{ "timestamp": "YYYY-MM-DD hh:mm:ss", // UTC+0 "platform": 1, "push_enabled": 100, "push_disabled": 100 }]}
Codes de réponse
{ "statistics": [{ "timestamp": "YYYY-MM-DD hh:mm:ss", "platform": 1, "push_enabled": 100, "push_disabled": 100 }]}
Explication : La requête a réussi et les statistiques sont retournées.
{ // Response}
Explication : La requête avait une syntaxe ou des paramètres invalides.
{ // Response}
Explication : Le serveur a rencontré une erreur. Veuillez réessayer plus tard.
{ // Response}
Explication : L’authentification a échoué. Vérifiez votre clé ou jeton API.
{ // Response}
Explication : Accès refusé pour le code d’application spécifié.
{ // Response}
Explication : Le code d’application n’a pas été trouvé ou n’existe pas.
Règles d’intervalle d’horodatage
Anchor link to| Période demandée
| Intervalle dans la réponse||-------------------|--------------------|
| Plus d’un an | 1 an |
| 1 an | 1 mois |
| 1 mois - 1 an | 1 jour |
| Moins d’un mois| 1 heure |