API Analytics

Récupérer les métriques de réponses et les statistiques de complétion de vos formulaires.

L'API Analytics fournit des métriques agrégées sur les réponses aux formulaires, incluant les totaux, les taux de complétion et les ventilations quotidiennes.

Tous les corps de réponse utilisent des noms de champs en snake_case.

Tableau de bord Analytics — Le tableau de bord analytics affichant les métriques de réponses et les taux de complétion.

Endpoints

GET/api/v1/forms/:id/analytics

Obtenir les analytics d'un formulaire

GET/api/v1/forms/:id/analytics

Renvoie les statistiques de réponses pour un formulaire spécifique. Vous pouvez optionnellement filtrer par plage de dates pour analyser des périodes précises.

Paramètres de chemin

idstring

L'identifiant du formulaire

Paramètres de requête

sincestring

Date ISO 8601. Inclure uniquement les réponses soumises à partir de cette date.

untilstring

Date ISO 8601. Inclure uniquement les réponses soumises jusqu'à cette date.

Champs de réponse

form_idstring

L'identifiant du formulaire

total_responsesinteger

Nombre total de soumissions (y compris partielles)

completed_responsesinteger

Nombre de soumissions entièrement complétées

completion_ratenumber

Pourcentage de réponses complétées (0-100, arrondi à 2 décimales)

average_completion_time_secondsinteger or null

Temps moyen en secondes entre la première réponse et la complétion. null si aucune réponse complétée.

responses_by_dayarray

Ventilation quotidienne du nombre de réponses

responses_by_day[].datestring

Date au format YYYY-MM-DD

responses_by_day[].totalinteger

Total des réponses soumises à cette date

responses_by_day[].completedinteger

Réponses complétées à cette date

Réponse

json

{
  "form_id": "665a1b2c3d4e5f6a7b8c9d0e",
  "total_responses": 342,
  "completed_responses": 298,
  "completion_rate": 87.13,
  "average_completion_time_seconds": 194,
  "responses_by_day": [
    { "date": "2026-02-22", "total": 18, "completed": 16 },
    { "date": "2026-02-23", "total": 24, "completed": 21 },
    { "date": "2026-02-24", "total": 31, "completed": 27 },
    { "date": "2026-02-25", "total": 22, "completed": 20 },
    { "date": "2026-02-26", "total": 28, "completed": 25 },
    { "date": "2026-02-27", "total": 35, "completed": 30 },
    { "date": "2026-02-28", "total": 12, "completed": 11 }
  ]
}

Exemples de code

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/analytics?since=2026-02-01&until=2026-02-28" \
  -H "Authorization: Bearer YOUR_API_KEY"

Conseils de requêtage

Utilisez les paramètres de requête since et until pour contrôler la plage de dates des analytics.

Historique complet

Omettez since et until pour obtenir les analytics sur toute la durée de vie du formulaire.

7 derniers jours

Calculez la date d'il y a 7 jours et passez-la comme paramètre since pour obtenir une fenêtre glissante hebdomadaire.

Mois spécifique

Passez le premier et le dernier jour du mois comme since et until pour obtenir les analytics d'un mois calendaire spécifique.

Historique complet

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

7 derniers jours

javascript

const since = new Date();
since.setDate(since.getDate() - 7);

const response = await fetch(
  `https://api.nueform.io/api/v1/forms/${formId}/analytics?since=${since.toISOString().split("T")[0]}`,
  { headers: { Authorization: "Bearer YOUR_API_KEY" } }
);

Mois spécifique

python

response = requests.get(
    f"https://api.nueform.io/api/v1/forms/{form_id}/analytics",
    params={"since": "2026-01-01", "until": "2026-01-31"},
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)

Réponses d'erreur

Réponses d'erreur standard renvoyées par ce point d'accès.

Codes d'erreur

400Bad Request

Format de date invalide pour since ou until

401Unauthorized

Clé API manquante ou invalide

403Forbidden

Permissions insuffisantes pour les formulaires d'équipe

404Not Found

Formulaire introuvable

500Server Error

Erreur interne du serveur

Exemple d'erreur

json

{
  "error": "Form not found"
}

Dernière mise à jour : 6 avril 2026