# Lire une version d’un modèle de rapport privé URL canonique : https://sosoapi.ai/fr/docs/api/analytics-api-reporting-templates-get Contrat : sha256:d6e85a113e8fb367 Lire une version d’un modèle de rapport privé. Utilise le jeu de données et la version explicitement vérifiés ; les sources ne sont pas actualisées automatiquement. Les données d’entrée de génération peuvent être transmises par un tube à sosoapi report render --output FILE. POST /analytics-api/reporting/templates/get ## Authentification et autorisations - **Types d’identifiants acceptés:** user_session, delegated_oauth, personal_access_token - **Capacité déléguée:** agent:operate - **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)$" }, "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)$" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 } }, "required": [ "workspace_id", "id", "version" ], "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": { "contractVersion": { "type": "string", "const": "analytics-template/v1" }, "workspaceId": { "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)$" }, "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)$" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "format": { "type": "string", "enum": [ "pptx", "docx", "xlsx" ] }, "sourceBase64": { "type": "string", "maxLength": 12582912, "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" }, "sourceSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mappings": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,63}$" }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" }, "value": { "type": "string", "maxLength": 2000 } }, "required": [ "kind", "value" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "selection" }, "field": { "type": "string", "enum": [ "accounts", "period", "timezone", "platforms", "dataset", "reviewed", "coverage" ] } }, "required": [ "kind", "field" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "metric" }, "platform": { "type": "string", "enum": [ "facebook", "instagram", "threads", "youtube" ] }, "key": { "type": "string", "minLength": 1, "maxLength": 150 }, "unit": { "type": "string", "minLength": 1, "maxLength": 100 }, "grain": { "type": "string", "enum": [ "post", "account" ] }, "measurementKind": { "type": "string", "enum": [ "lifetime", "snapshot", "period", "unknown" ] }, "accountId": { "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)$" }, "providerResourceId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 512 }, { "type": "null" } ] }, "sourcePath": { "type": "string", "maxLength": 2000 }, "requestId": { "anyOf": [ { "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)$" }, { "type": "null" } ] } }, "required": [ "kind", "platform", "key", "unit", "grain", "measurementKind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "formula" }, "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)$" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 } }, "required": [ "kind", "id", "version" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table" }, "source": { "type": "string", "enum": [ "measurements", "formulas" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "kind", "source", "limit" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "chart" }, "source": { "type": "string", "const": "publication_by_platform" } }, "required": [ "kind", "source" ] } ] } }, "createdAt": { "type": "string", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "format": "date-time" } }, "required": [ "contractVersion", "workspaceId", "id", "version", "name", "format", "sourceBase64", "sourceSha256", "mappings", "createdAt" ] } ``` ## 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, 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", "id": "11111111-1111-4111-8111-111111111111", "version": 1 } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/reporting/templates/get" \ -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/analytics-api/reporting/templates/get", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "version": 1 }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /analytics-api/reporting/templates/get < request.json ``` Exemple de réponse fictive ```json { "contractVersion": "analytics-template/v1", "workspaceId": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "version": 1, "name": "example", "format": "pptx", "sourceBase64": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "mappings": {}, "createdAt": "2099-01-15T09:00:00Z" } ``` ## Outils et guides associés MCP: sosoapi_get_report_template [Référence API](https://sosoapi.ai/fr/docs/api)