Clari Hello World

VérifiéPrudence

Exportez votre première prévision Clari et un instantané de pipeline. Utilisez pour tester la connectivité de l'API Clari, récupérer des données de prévision ou apprendre la structure de l'API d'exportation.

Spar Skills Guide Bot
DeveloppementDébutant
23/07/2026
Claude Code
#clari#api-integration#forecast-export#saas#revenue-intelligence

Recommandé pour

Synthèse automatique

Réalise les premiers appels à l'API Clari Export : lister les prévisions disponibles, lancer l'export d'un snapshot de forecast et suivre l'état du job jusqu'au téléchargement des données.

Points forts

  • Séquence complète en quatre étapes avec des extraits curl et Python directement réutilisables
  • Inclut le polling du statut du job et le téléchargement/parsing du fichier de résultat
  • Table d'erreurs courantes (401, nom de forecast introuvable, job en attente) avec correctifs
  • Commence par lister les forecasts pour récupérer le nom exact attendu par l'endpoint d'export

Limites

  • Suppose une clé CLARI_API_KEY valide et au moins un forecast configuré dans Clari
  • Ne couvre pas la configuration d'authentification initiale, laissée au skill clari-install-auth
  • La boucle de polling est bloquante et sans timeout ni backoff
Quand l'utiliser

Pour vérifier la connectivité à l'API Clari ou prototyper rapidement un export de données forecast et quota.

Quand l'éviter

Si vous avez besoin d'exports planifiés récurrents ou de transformations de données au-delà du simple téléchargement brut.

Analyse de sécurité

Prudence
Score qualité86/100

This is a legitimate Clari export workflow with no destructive commands, obfuscation, or obvious secret exfiltration. Because it handles an API key and uses network-enabled shell/Python tools, it is best classified as caution rather than fully safe.

Points d'attention
  • •Uses Bash(curl:*) and Bash(python3:*) with network access to api.clari.com and reads CLARI_API_KEY from the environment.
  • •The polling loop is unbounded (`while True`) and has no timeout or maximum retry count, so a stuck export could poll indefinitely.
  • •Step 4 downloads from a server-provided `downloadUrl` without checking HTTP status or validating the host; this is low risk for the trusted Clari API but worth noting.
Comment cette analyse est faite

Exemples

Test Clari API connectivity
Run the clari hello world flow: list my available forecasts and show their IDs and time periods.
Export Q1 forecast snapshot
Export the company_forecast for 2026_Q1 from Clari including quota and CRM totals, then poll the job and print the download URL.
Parse exported forecast data
Download the completed Clari export job and print a per-rep summary of forecast amount vs quota.

name: clari-hello-world description: 'Export your first Clari forecast and pipeline snapshot.

Use when testing Clari API connectivity, pulling forecast data,

or learning the export API structure.

Trigger with phrases like "clari hello world", "clari first export",

"clari test api", "clari forecast export".

' allowed-tools: Read, Write, Edit, Bash(curl:), Bash(python3:) version: 1.6.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io tags:

  • saas
  • revenue-intelligence
  • forecasting
  • clari compatibility: Designed for Claude Code

Clari Hello World

Overview

First API calls against Clari: list available forecasts, export a forecast snapshot, and check export job status. The Clari Export API is the primary integration point for getting forecast, quota, and CRM data out of Clari.

Prerequisites

  • Completed clari-install-auth setup
  • CLARI_API_KEY environment variable set
  • At least one forecast configured in Clari

Instructions

Step 1: List Available Forecasts

curl -s -H "apikey: ${CLARI_API_KEY}" \
  https://api.clari.com/v4/export/forecast/list \
  | jq '.forecasts[] | {forecastName, forecastId, timePeriods}'

Step 2: Export a Forecast

import requests
import json
import os
import time

api_key = os.environ["CLARI_API_KEY"]
headers = {"apikey": api_key, "Content-Type": "text/plain"}

# Replace with your forecast name from Step 1
forecast_name = "company_forecast"

payload = json.dumps({
    "timePeriod": "2026_Q1",
    "typesToExport": [
        "forecast",
        "quota",
        "forecast_updated",
        "adjustment",
        "crm_total",
        "crm_closed"
    ],
    "currency": "USD",
    "schedule": "NONE",
    "includeHistorical": False,
    "exportFormat": "JSON"
})

response = requests.post(
    f"https://api.clari.com/v4/export/forecast/{forecast_name}",
    headers=headers,
    data=payload,
)
response.raise_for_status()

job = response.json()
print(f"Export job started: {job['jobId']}")
print(f"Status: {job['status']}")

Step 3: Check Export Job Status

# Poll for job completion
job_id = job["jobId"]

while True:
    status_resp = requests.get(
        f"https://api.clari.com/v4/export/jobs/{job_id}",
        headers={"apikey": api_key},
    )
    status = status_resp.json()

    if status["status"] == "COMPLETED":
        print(f"Export ready: {status['downloadUrl']}")
        break
    elif status["status"] == "FAILED":
        print(f"Export failed: {status.get('error', 'Unknown')}")
        break

    print(f"Status: {status['status']}... waiting 5s")
    time.sleep(5)

Step 4: Download and Parse Results

if status["status"] == "COMPLETED":
    download = requests.get(status["downloadUrl"])
    forecast_data = download.json()

    # Print summary
    for entry in forecast_data.get("entries", [])[:5]:
        print(f"  Rep: {entry.get('ownerName')}")
        print(f"  Forecast: ${entry.get('forecastAmount', 0):,.0f}")
        print(f"  Quota: ${entry.get('quotaAmount', 0):,.0f}")
        print()

Output

  • List of forecasts with IDs and time periods
  • Exported forecast data with rep-level calls
  • Quota, adjustments, and CRM totals

Error Handling

| Error | Cause | Solution | |-------|-------|----------| | 401 Unauthorized | Bad API key | Regenerate token in Clari settings | | No forecasts listed | Wrong org or no forecasts configured | Contact Clari admin | | Job stays PENDING | Large export | Wait longer, check job status endpoint | | 404 on forecast name | Name mismatch | Use exact name from list endpoint |

Resources

Next Steps

Proceed to clari-local-dev-loop for development workflow setup.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/clari-hello-world-mrx3xywb/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/clari-hello-world-mrx3xywb' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/clari-hello-world-mrx3xywb/download' --output '.skill-downloads/clari-hello-world-mrx3xywb/SKILL.md.part' && mv '.skill-downloads/clari-hello-world-mrx3xywb/SKILL.md.part' '.skill-downloads/clari-hello-world-mrx3xywb/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Environnement déclaré par l’auteur : Designed for Claude Code

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Write, Edit, Bash(curl:*), Bash(python3:*)

Extrait original : Prerequisites
  • Completed clari-install-auth setup
  • CLARI_API_KEY environment variable set
  • At least one forecast configured in Clari

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/clari-hello-world-mrx3xywb/SKILL.md' && test -s '.skill-downloads/clari-hello-world-mrx3xywb/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/clari-hello-world' && cp -R '.skill-downloads/clari-hello-world-mrx3xywb' '.claude/skills/clari-hello-world'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/clari-hello-world-mrx3xywb'

openskills read 'clari-hello-world-mrx3xywb'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/clari-hello-world-mrx3xywb/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires