# Rechercher des statistiques publicitaires URL canonique : https://sosoapi.ai/fr/docs/api/advertising-api-insights-query Contrat : sha256:9aedef8d43dd4514 Récupérer un volume limité de résultats publicitaires payants officiels avec dates, fuseau horaire, devise, fenêtre d’attribution et action de conversion explicites. Les métriques manquantes restent manquantes. POST /advertising-api/insights/query ## Authentification et autorisations - **Types d’identifiants acceptés:** user_session, delegated_oauth, personal_access_token - **Capacité déléguée:** agent:advertising_read - **Rôle minimal dans l’espace de travail:** viewer - **Périmètre d’accès:** Ressources auxquelles cet utilisateur est autorisé à accéder - **Consentement pour tous les espaces requis:** Non - **Modifie l’état:** Non - **Lorsque l’opération est terminée:** synchronous_http_response Un jeton ne peut utiliser que les droits de son propriétaire. Chaque requête vérifie l’appartenance à l’espace, la propriété des ressources, les espaces sélectionnés et les capacités accordées. Les profils core et full modifient les outils affichés ; ils n’accordent aucun accès. ## Champs de requête ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "advertising_account_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "level": { "type": "string", "enum": [ "campaign", "adset", "ad" ] }, "start_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "end_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "action_attribution_windows": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "enum": [ "1d_click", "7d_click", "1d_view" ] } }, "action_report_time": { "type": "string", "enum": [ "impression", "conversion" ] }, "conversion_action_type": { "type": "string", "pattern": "^[a-z][a-z0-9_.]{0,99}$" }, "revenue_action_type": { "type": "string", "pattern": "^[a-z][a-z0-9_.]{0,99}$" }, "after": { "type": "string", "maxLength": 2048 }, "limit": { "default": 25, "type": "integer", "minimum": 1, "maximum": 50 } }, "required": [ "workspace_id", "advertising_account_id", "level", "start_date", "end_date", "action_attribution_windows", "action_report_time", "conversion_action_type", "revenue_action_type" ], "additionalProperties": false } ``` ## Réponse et achèvement Statuts HTTP de réussite : 200 Une réponse HTTP réussie peut signifier qu’une requête est acceptée plutôt que terminée. Pour le travail en arrière-plan, conservez l’identifiant renvoyé et suivez la même opération jusqu’à sa fin. Une publication programmée ou acceptée n’est publiée que lorsque la plateforme le confirme ; une expiration côté client ne détermine pas le résultat. ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "contract_version": { "type": "string", "const": "ad-performance/v1" }, "source_id": { "type": "string", "maxLength": 100 }, "source_sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "identity_verification": { "type": "string", "enum": [ "customer_supplied", "accepted_provider_grant" ] }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "timezone": { "type": "string", "maxLength": 100 }, "selection": { "type": "object", "properties": { "provider_api_version": { "type": "string", "const": "v26.0" }, "provider_account_id": { "type": "string", "pattern": "^[1-9]\\d{1,24}$" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "timezone": { "type": "string", "maxLength": 100 }, "level": { "type": "string", "enum": [ "campaign", "adset", "ad" ] }, "start_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "end_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "action_attribution_windows": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "enum": [ "1d_click", "7d_click", "1d_view" ] } }, "action_report_time": { "type": "string", "enum": [ "impression", "conversion" ] }, "conversion_action_type": { "type": "string", "maxLength": 100 }, "revenue_action_type": { "type": "string", "maxLength": 100 } }, "required": [ "provider_api_version", "provider_account_id", "currency", "timezone", "level", "start_date", "end_date", "action_attribution_windows", "action_report_time", "conversion_action_type", "revenue_action_type" ] }, "complete": { "type": "boolean" }, "rows": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "row_id": { "type": "string", "maxLength": 100 }, "metrics": { "type": "object", "properties": { "spend": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "clicks": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "conversions": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "attributed_revenue": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "cpc": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "cpa": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "attributed_roas": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] } }, "required": [ "spend", "clicks", "conversions", "attributed_revenue", "cpc", "cpa", "attributed_roas" ] } }, "required": [ "row_id", "metrics" ] } }, "totals": { "type": "object", "properties": { "spend": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "clicks": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "conversions": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "attributed_revenue": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "cpc": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "cpa": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] }, "attributed_roas": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string", "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": [ "currency", "count", "currency_per_click", "currency_per_conversion", "ratio" ] }, "availability": { "type": "string", "enum": [ "available", "missing_input", "zero_denominator", "incompatible", "partial" ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "value", "unit", "availability", "reason", "input_refs" ] } }, "required": [ "spend", "clicks", "conversions", "attributed_revenue", "cpc", "cpa", "attributed_roas" ] }, "gaps": { "maxItems": 1000, "type": "array", "items": { "type": "string", "maxLength": 300 } }, "suggestions": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "rule_id": { "type": "string", "enum": [ "supply_revenue", "review_comparable_creative_test", "complete_coverage" ] }, "rule_version": { "type": "number", "const": 1 }, "proposal": { "type": "string", "maxLength": 600 }, "input_refs": { "maxItems": 2000, "type": "array", "items": { "type": "string", "maxLength": 300 } }, "limitations": { "type": "string", "const": "Observational comparison only; no causal uplift or profitability claim. Human review required." } }, "required": [ "rule_id", "rule_version", "proposal", "input_refs", "limitations" ] } }, "advertising_account_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "next_cursor": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "required": [ "contract_version", "source_id", "source_sha256", "identity_verification", "currency", "timezone", "selection", "complete", "rows", "totals", "gaps", "suggestions", "advertising_account_id", "next_cursor" ] } ``` ## Erreurs et nouvelles tentatives sûres Vérifiez le statut HTTP et le corps de réponse. Une erreur de validation 400 peut contenir un ZodError ; les erreurs des gestionnaires utilisent les champs error, message et code. Conservez request_id ou x-request-id pour le diagnostic, sans identifiants secrets. Corrigez les erreurs d’accès 401/403 avant de réessayer et respectez Retry-After pour 429. Si une écriture est incertaine ou renvoie 5xx, lisez d’abord le résultat existant. Réutilisez une clé d’idempotence uniquement lorsque c’est pris en charge ; le comportement des nouvelles tentatives varie selon l’opération et ne garantit pas une diffusion exactement une fois. ## Exemples Ces exemples utilisent des valeurs fictives vérifiées contre les schémas. Remplacez les identifiants par ceux que vous êtes autorisé à utiliser, les médias par des ressources prêtes et les dates par l’heure confirmée. Vérifiez l’éligibilité du compte avant toute écriture. Cette page n’envoie aucune requête API. Définissez SOSOAPI_ACCESS_TOKEN sur votre serveur avec un identifiant accepté par cette opération et gardez-le hors du code navigateur. Pour un agent IA, utilisez sosoapi auth login pour vous connecter dans le navigateur et laissez la CLI actualiser ses identifiants. request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "advertising_account_id": "11111111-1111-4111-8111-111111111111", "level": "campaign", "start_date": "2099-01-15", "end_date": "2099-01-15", "action_attribution_windows": [ "1d_click" ], "action_report_time": "impression", "conversion_action_type": "example", "revenue_action_type": "example" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/insights/query" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // Server-side JavaScript. Do not print tokens or credential-bearing responses. const token = process.env.SOSOAPI_ACCESS_TOKEN; if (!token) throw new Error("Set an accepted credential for this operation"); const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/insights/query", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "advertising_account_id": "11111111-1111-4111-8111-111111111111", "level": "campaign", "start_date": "2099-01-15", "end_date": "2099-01-15", "action_attribution_windows": [ "1d_click" ], "action_report_time": "impression", "conversion_action_type": "example", "revenue_action_type": "example" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /advertising-api/insights/query < request.json ``` Exemple de réponse fictive ```json { "contract_version": "ad-performance/v1", "source_id": "example", "source_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity_verification": "customer_supplied", "currency": "USD", "timezone": "UTC", "selection": { "provider_api_version": "v26.0", "provider_account_id": "12345", "currency": "USD", "timezone": "UTC", "level": "campaign", "start_date": "2099-01-15", "end_date": "2099-01-15", "action_attribution_windows": [ "1d_click" ], "action_report_time": "impression", "conversion_action_type": "example", "revenue_action_type": "example" }, "complete": false, "rows": [], "totals": { "spend": { "value": null, "unit": "currency", "availability": "available", "reason": null, "input_refs": [] }, "clicks": { "value": null, "unit": "currency", "availability": "available", "reason": null, "input_refs": [] }, "conversions": { "value": null, "unit": "currency", "availability": "available", "reason": null, "input_refs": [] }, "attributed_revenue": { "value": null, "unit": "currency", "availability": "available", "reason": null, "input_refs": [] }, "cpc": { "value": null, "unit": "currency", "availability": "available", "reason": null, "input_refs": [] }, "cpa": { "value": null, "unit": "currency", "availability": "available", "reason": null, "input_refs": [] }, "attributed_roas": { "value": null, "unit": "currency", "availability": "available", "reason": null, "input_refs": [] } }, "gaps": [], "suggestions": [], "advertising_account_id": "11111111-1111-4111-8111-111111111111", "next_cursor": null } ``` ## Outils et guides associés MCP: sosoapi_ads_insights_query [Référence API](https://sosoapi.ai/fr/docs/api)