Entwickler

Dokumentation, Header und Erkennung der Entwickler-API

Die externe API, der API-Schlüssel-Workflow, der MCP-Transport und die maschinenlesbaren Erkennungsdateien werden hier mit den vom Produkt verwendeten Live-Pfaden dokumentiert.

API-Schlüssel

Erstellen und widerrufen Sie Schlüssel unter Dashboard > Einstellungen > API-Schlüssel oder verwenden Sie die angemeldeten Verwaltungsrouten.

Nur Professional und Enterprise.

REST-API

Call https://tubeanalytics.net/api/external/v1 with Bearer auth.

JSON-Antworten mit strukturierten Fehlern.

MCP-Transport

Connect agents to https://tubeanalytics.net/api/mcp or use npm run mcp:stdio.

Streambares HTTP und stdio werden unterstützt.

Discovery-Dateien

Use /openapi.json, /mcp.json, /ai-pricing.json, and /ai.txt as the machine-readable source of truth.

Immer aktuell mit den Live-Routen.

Schnellstart

Versuchen Sie es mit einem Live-Endpunkt. Ersetzen Sie „channel_id“ und „ YOUR_API_KEY“ durch echte Werte:

curl -X GET "https://tubeanalytics.net/api/external/v1/analytics?channel_id=<channel_id>&range=28d" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Accept: application/json"

JavaScript

const res = await fetch("https://tubeanalytics.net/api/external/v1/analytics?channel_id=<id>&range=28d", {
  headers: { Authorization: "Bearer <api_key>" }
});
const data = await res.json();

Python

import httpx
res = httpx.get(
    f"{apiBase}/analytics",
    params={"channel_id": "<id>", "range": "28d"},
    headers={"Authorization": "Bearer <api_key>"}
)
data = res.json()
channel_id accepts either the TubeAnalytics channel ID or the YouTube channel ID. The same Bearer key works for every external endpoint below. API access requires a Professional or Enterprise plan.

So verbinden Sie sich

1

Verknüpfen Sie einen YouTube-Kanal im Dashboard

Externe API-Daten stammen von verbundenen Kanälen. Melden Sie sich an, verbinden Sie einen Kanal und warten Sie, bis die erste Synchronisierung abgeschlossen ist, bevor Sie Server-zu-Server-Aufrufe tätigen.

2

Erstellen Sie einen API-Schlüssel

Öffnen Sie Dashboard > Einstellungen > API-Schlüssel in einem Professional- oder Enterprise-Konto oder rufen Sie POST /api/v1/keys aus einer authentifizierten Sitzung auf.

3

Senden Sie über den Inhaber authentifizierte Anfragen

Verwenden Sie Authorization: Bearer <api_key> bei jeder externen Anfrage. Behalten Sie die Schlüssel serverseitig bei und betten Sie sie nicht in den Clientcode ein.

4

Verwenden Sie Erkennungsdateien für Tools und Agents

Rufen Sie die OpenAPI-Spezifikation, das MCP-Manifest, das AI-Pricing-Manifest und die Datei ai.txt ab, wenn Sie Clients generieren, Agenten verbinden oder Integrationen validieren.

Referenzendpunkte

https://tubeanalytics.net/api/external/v1undefined
Listen Sie verbundene Kanäle mit Namen, YouTube-ID und Verbindungsstatus auf
https://tubeanalytics.net/api/external/v1undefined
Rufen Sie einen verbundenen Kanal anhand der internen ID oder der YouTube-Kanal-ID ab
https://tubeanalytics.net/api/external/v1undefined
Aggregierte Analysen: Aufrufe, Abonnenten, Wiedergabezeit, CTR, Verkehrsquellen – gefiltert nach Bereich
https://tubeanalytics.net/api/external/v1undefined
Paginierte Videos mit Aufrufen pro Video, CTR, Veröffentlichungsdatum – unterstützt Sortierung, Begrenzung und Versatz
https://tubeanalytics.net/api/external/v1undefined
Zielgruppendemografie (Alter, Geschlecht, Region), Abonnentengesundheit und Segmentaufschlüsselung
https://tubeanalytics.net/api/external/v1undefined
Verfolgte Konkurrenten mit Abonnentenzahlen, durchschnittlichen Aufrufen und geschätzten RPM-Bereichen
Die Erkennungsdateien unter /openapi.json, /mcp.json und /ai.txt sind die maschinenlesbare Quelle der Wahrheit.

Abfrageparameter

Die meisten externen API-Endpunkte akzeptieren allgemeine Abfrageparameter zum Filtern, Paginieren und Sortieren. Das vollständige Schema pro Endpunkt ist in der OpenAPI-Spezifikation enthalten.

channel_id
string
Erforderlich für Analysen, Videos und Zielgruppe. Akzeptiert die interne TubeAnalytics-ID oder die YouTube-Kanal-ID.
range
string
Zeitfenster: 7 Tage, 28 Tage (Standard), 90 Tage, 365 Tage.
limit
integer
Ergebnisse pro Seite. Standard 20, maximal 100.
offset
integer
Datensätze zum Überspringen. Mit limit verwenden, um durch Ergebnismengen zu paginieren.
sort
string
Sortierfeld (z. B. „publicatedAt“, „views“, „ctr“). Präfix mit - für absteigend.

Authentifizierung und Header

Externe Anfragen verwenden das Bearer-API-Schlüsselschema im Authorization-Header. Behalten Sie den Schlüssel serverseitig. Erstellen und rotieren Sie Schlüssel über Dashboard > Einstellungen > API-Schlüssel oder die angemeldeten Verwaltungsrouten.

Authorization
Bearer <api_key>
Accept
application/json
Content-Type
application/json
Rate-limit headers
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Retry header
Retry-After on 429 responses

Angemeldete Verwaltungsrouten

Diese Routen gelten für authentifizierte Dashboard-Sitzungen, nicht für Server-zu-Server-API-Clients:

  • GET /api/v1/keys API-Schlüssel auflisten
  • POST /api/v1/keys Erstellen Sie einen neuen API-Schlüssel
  • DELETE /api/v1/keys/:keyId einen Schlüssel widerrufen
  • GET /api/v1/users/profile and related dashboard session routes bleiben getrennt
API-Schlüssel sind nur für Professional- und Enterprise-Pläne verfügbar. Starter-Benutzer sehen in den Einstellungen eine Upgrade-Eingabeaufforderung.

Zugang und Grenzen

Die Preisoberfläche kündigt monatliche API-Aufrufkontingente nach Plan an, während die externe Live-API ein Anforderungslimit mit gleitendem Fenster erzwingt und bei jeder Antwort Ratenlimit-Header zurückgibt. Berücksichtigen Sie beides beim Erstellen von Client-Wiederholungsversuchen und Kontingent-Dashboards.

Starter
1 channel max channels
Unavailable
Upgrade required
No external API access
Professional
3 channels max channels
Enabled
5,000 calls / month
1,000 requests/hour
Enterprise
5 channels max channels
Enabled
20,000 calls / month
10,000 requests/hour

In der aktuellen Implementierung gibt die externe API X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset bei erfolgreichen Antworten zurück, plus Retry-After, wenn eine Anfrage begrenzt ist.

Fehlerformat

Externe API-Routen geben strukturierte JSON-Fehler mit error.code und error.message zurück. Verwenden Sie den Code, um auf die Fehlerbehandlung und die Meldung für menschenlesbare Protokolle zu verzweigen.

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "channel_id query parameter is required"
  }
}

Gemeinsame Status

  • 400 Fehlende oder ungültige Anforderungsparameter
  • 401 Fehlender oder ungültiger API-Schlüssel
  • 403 API-Schlüssel gültig, aber der Plan ist nicht berechtigt
  • 404 Verbundener Kanal oder Ressource nicht gefunden
  • 429 Ratenlimit überschritten
  • 500 Unerwarteter Serverfehler

Bereit zum Bauen?

Melden Sie sich für einen Professional- oder Enterprise-Plan an, um API-Zugriff zu erhalten. Sie haben bereits ein Konto? Wechseln Sie zum Dashboard, um API-Schlüssel zu erstellen.