REST API Dokumentation

TL;DR

Generieren Sie einen persönlichen API-Schlüssel in Ihren Kontoeinstellungen. Verwenden Sie dann Standard-HTTP-GET-Anfragen mit Ihrem API-Schlüssel, um Sichtbarkeitswerte, Erwähnungen und Sentimentdaten von ChatGPT, Gemini, Perplexity und Claude abzurufen. Funktioniert mit Excel, Google Sheets, Power BI, Tableau, Python und jedem anderen HTTP-Client.

Inhaltsverzeichnis

1. Basis-URL
2. Authentifizierung
3. Rate Limits
4. Endpunkte
   1. GET /api/v1/looker/schema
   2. GET /api/v1/looker/data
   3. GET /api/v1/looker/selections
5. Datenfeld-Referenz
6. Antwortformat
7. Fehlerbehandlung
8. Codebeispiele
9. FAQ

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

curl "https://your-domain.com/api/v1/looker/data?api_key=avt_your_key_here"

Gibt das Datenschema mit Feldnamen, Typen und semantischen Informationen zurück. Nützlich, um die Datenstruktur vor der Abfrage zu verstehen.

Parameter: Keine

Beispielanfrage:

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

Beispielantwort:

{
  "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"
      }
    }
  ]
}

Gibt Ihre AI-Sichtbarkeits-Analyseergebnisse zurück. Unterstützt Filterung nach Datum, Themenfeld und AI-System. Enthält Paginierung für große Datensätze.

Query-Parameter:

Beispielanfrage:

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"

Beispielantwort:

{
  "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
  }
}

Gibt eine Liste Ihrer Themenfelder (Auswahlen) mit ihren IDs zurück. Verwenden Sie diese IDs, um Daten im /data-Endpunkt zu filtern.

Parameter: Keine

Beispielanfrage:

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

Beispielantwort:

{
  "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}"}

# Alle Themenfelder abrufen
selections = requests.get(f"{BASE_URL}/selections", headers=headers).json()
print(selections)

# Sichtbarkeitsdaten für Januar 2025 abrufen
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']}")

# Durch alle Ergebnisse paginieren
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}` };

// Sichtbarkeitsdaten abrufen
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`);

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

# Daten mit Filtern abrufen
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"

# Themenfelder abrufen
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());

  // Daten in das aktive Tabellenblatt schreiben
  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);
}