Documentation REST API

TL;DR

Générez une clé API personnelle dans les paramètres de votre compte. Utilisez ensuite des requêtes HTTP GET standard avec votre clé API pour récupérer les scores de visibilité, le nombre de mentions et les données de sentiment de ChatGPT, Gemini, Perplexity et Claude. Fonctionne avec Excel, Google Sheets, Power BI, Tableau, Python et tout autre client HTTP.

Table des matières

1. URL de base
2. Authentification
3. Accès payant par demande (MPP)
4. Limites de débit
5. Endpoints
   1. GET /api/v1/looker/schema
   2. GET /api/v1/looker/data
   3. GET /api/v1/looker/selections
6. Référence des champs de données
7. Format de réponse
8. Gestion des erreurs
9. Exemples de code
10. FAQ

curl -H "Authorization: Bearer avt_your_key_here" \
  https://your-domain.com/api/v1/looker/data

# First request without credentials
curl -i https://your-domain.com/api/v1/looker/data

# HTTP/1.1 402 Payment Required
# WWW-Authenticate: Payment challenge="...", ...

# Réessayer avec le credential de paiement
curl -H "Authorization: Payment <credential>" \
  https://your-domain.com/api/v1/looker/data

Renvoie le schéma de données avec les noms de champs, les types et les informations sémantiques. Utile pour comprendre la structure des données avant d'interroger.

Paramètres : Aucun

Exemple de requête :

curl -H "Authorization: Bearer avt_your_key_here" \
  https://your-domain.com/api/v1/looker/schema

Exemple de réponse :

{
  "schema": [
    {
      "name": "date",
      "label": "Date",
      "dataType": "STRING",
      "semantics": {
        "conceptType": "DIMENSION",
        "semanticType": "YEAR_MONTH_DAY"
      }
    },
    {
      "name": "visibility_score",
      "label": "Visibility Score",
      "dataType": "NUMBER",
      "semantics": {
        "conceptType": "METRIC"
      }
    }
  ]
}

Renvoie vos résultats d'analyse de visibilité AI. Supporte le filtrage par date, domaine thématique et système AI. Inclut la pagination pour les grands ensembles de données.

Paramètres de requête :

Exemple de requête :

curl -H "Authorization: Bearer avt_your_key_here" \
  "https://your-domain.com/api/v1/looker/data?date_from=2025-01-01&date_to=2025-01-31&ai_system=chatgpt&limit=500"

Exemple de réponse :

{
  "data": [
    {
      "date": "20250115",
      "topic_area": "Brand Monitoring",
      "prompt": "What is the best project management tool?",
      "category": "Product Comparison",
      "funnel_stage": "Consideration",
      "ai_system": "chatgpt",
      "brand": "Asana",
      "visibility_score": 75,
      "mention_count": 3,
      "position_score": 85,
      "sentiment_score": 0.8,
      "web_search_used": false
    }
  ],
  "pagination": {
    "total": 1250,
    "limit": 500,
    "offset": 0,
    "has_more": true
  }
}

Renvoie une liste de vos domaines thématiques (sélections) avec leurs IDs. Utilisez ces IDs pour filtrer les données dans l'endpoint /data.

Paramètres : Aucun

Exemple de requête :

curl -H "Authorization: Bearer avt_your_key_here" \
  https://your-domain.com/api/v1/looker/selections

Exemple de réponse :

{
  "selections": [
    {
      "id": 42,
      "name": "Brand Monitoring",
      "description": "Track brand mentions across AI platforms",
      "prompt_count": 25,
      "is_active": true,
      "created_at": "2025-01-10T14:30:00"
    }
  ]
}

import requests

API_KEY = "avt_your_key_here"
BASE_URL = "https://your-domain.com/api/v1/looker"

headers = {"Authorization": f"Bearer {API_KEY}"}

# Récupérer tous les domaines thématiques
selections = requests.get(f"{BASE_URL}/selections", headers=headers).json()
print(selections)

# Récupérer les données de visibilité pour janvier 2025
params = {
    "date_from": "2025-01-01",
    "date_to": "2025-01-31",
    "limit": 1000
}
data = requests.get(f"{BASE_URL}/data", headers=headers, params=params).json()
print(f"Total records: {data['pagination']['total']}")

# Paginer à travers tous les résultats
all_records = []
offset = 0
while True:
    params["offset"] = offset
    response = requests.get(f"{BASE_URL}/data", headers=headers, params=params).json()
    all_records.extend(response["data"])
    if not response["pagination"]["has_more"]:
        break
    offset += params["limit"]

print(f"Fetched {len(all_records)} records total")

const API_KEY = "avt_your_key_here";
const BASE_URL = "https://your-domain.com/api/v1/looker";

const headers = { "Authorization": `Bearer ${API_KEY}` };

// Récupérer les données de visibilité
const response = await fetch(`${BASE_URL}/data?date_from=2025-01-01&limit=500`, { headers });
const result = await response.json();
console.log(`Total: ${result.pagination.total} records`);

# Récupérer le schéma
curl -H "Authorization: Bearer avt_your_key_here" \
  https://your-domain.com/api/v1/looker/schema

# Récupérer les données avec filtres
curl -H "Authorization: Bearer avt_your_key_here" \
  "https://your-domain.com/api/v1/looker/data?date_from=2025-01-01&ai_system=chatgpt&limit=100"

# Récupérer les domaines thématiques
curl -H "Authorization: Bearer avt_your_key_here" \
  https://your-domain.com/api/v1/looker/selections

function getVisibilityData() {
  const API_KEY = "avt_your_key_here";
  const url = "https://your-domain.com/api/v1/looker/data?limit=500";

  const options = {
    headers: { "Authorization": "Bearer " + API_KEY },
    muteHttpExceptions: true
  };

  const response = UrlFetchApp.fetch(url, options);
  const json = JSON.parse(response.getContentText());

  // Écrire les données dans la feuille active
  const sheet = SpreadsheetApp.getActiveSheet();
  const headers = Object.keys(json.data[0]);
  sheet.getRange(1, 1, 1, headers.length).setValues([headers]);

  const rows = json.data.map(row => headers.map(h => row[h]));
  sheet.getRange(2, 1, rows.length, headers.length).setValues(rows);
}