Développeurs

Documentation, en-têtes et découverte de l'API du développeur

L'API externe, le workflow de clé API, le transport MCP et les fichiers de découverte lisibles par machine sont documentés ici avec les chemins en direct utilisés par le produit.

Clés API

Créez et révoquez des clés dans Tableau de bord > Paramètres > Clés API, ou utilisez les routes de gestion connectées.

Professionnel et Entreprise uniquement.

API REST

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

Réponses JSON avec des erreurs structurées.

Transports MCP

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

HTTP et stdio diffusables pris en charge.

Fichiers de découverte

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

Toujours au courant des itinéraires en direct.

Démarrage rapide

Essayez un point de terminaison en direct. Remplacez channel_id et YOUR_API_KEY par des valeurs réelles :

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.

Comment se connecter

1

Connectez une chaîne YouTube dans le tableau de bord

Les données de l'API externe proviennent de canaux connectés. Connectez-vous, connectez un canal et attendez la fin de la synchronisation initiale avant de passer des appels de serveur à serveur.

2

Créer une clé API

Ouvrez Tableau de bord > Paramètres > Clés API sur un compte Professionnel ou Entreprise, ou appelez POST /api/v1/keys à partir d'une session authentifiée.

3

Envoyer des demandes authentifiées par le porteur

Utilisez l'autorisation : Bearer <api_key> sur chaque demande externe. Conservez les clés côté serveur et ne les intégrez pas dans le code client.

4

Utiliser des fichiers de découverte pour les outils et les agents

Extrayez la spécification OpenAPI, le manifeste MCP, le manifeste de tarification ai et le fichier ai.txt lors de la génération de clients, de la connexion d'agents ou de la validation d'intégrations.

Critères de référence

https://tubeanalytics.net/api/external/v1undefined
Répertoriez les chaînes connectées avec leur nom, leur identifiant YouTube et l'état de la connexion
https://tubeanalytics.net/api/external/v1undefined
Récupérer une chaîne connectée par ID interne ou ID de chaîne YouTube
https://tubeanalytics.net/api/external/v1undefined
Analyses globales : vues, abonnés, durée de visionnage, CTR, sources de trafic – filtrées par plage
https://tubeanalytics.net/api/external/v1undefined
Vidéos paginées avec vues par vidéo, CTR, date de publication – prend en charge le tri, la limite et le décalage
https://tubeanalytics.net/api/external/v1undefined
Données démographiques de l'audience (âge, sexe, géolocalisation), santé des abonnés et répartition des segments
https://tubeanalytics.net/api/external/v1undefined
Suivi des concurrents avec le nombre d'abonnés, les vues moyennes et les plages de RPM estimées
Les fichiers de découverte sur /openapi.json, /mcp.json et /ai.txt constituent la source de vérité lisible par machine.

Paramètres de requête

La plupart des points de terminaison d'API externes acceptent les paramètres de requête courants pour le filtrage, la pagination et le tri. Le schéma complet par point de terminaison se trouve dans la spécification OpenAPI.

channel_id
string
Obligatoire pour les analyses, les vidéos et l'audience. Accepte l'identifiant TubeAnalytics interne ou l'identifiant de chaîne YouTube.
range
string
Fenêtre de temps : 7j, 28j (par défaut), 90j, 365j.
limit
integer
Résultats par page. Par défaut 20, maximum 100.
offset
integer
Enregistrements à ignorer. À utiliser avec limite pour paginer dans les ensembles de résultats.
sort
string
Champ de tri (par exemple, publiéAt, vues, ctr). Préfixe avec - pour décroissant.

Authentification et en-têtes

Les requêtes externes utilisent le schéma de clé de l'API Bearer dans l'en-tête Authorization. Conservez la clé côté serveur. Créez et faites pivoter des clés depuis Tableau de bord > Paramètres > Clés API ou les itinéraires de gestion connectés.

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

Itinéraires de gestion connectés

Ces itinéraires sont destinés aux sessions de tableau de bord authentifiées, et non aux clients API de serveur à serveur :

  • GET /api/v1/keys lister les clés API
  • POST /api/v1/keys créer une nouvelle clé API
  • DELETE /api/v1/keys/:keyId révoquer une clé
  • GET /api/v1/users/profile and related dashboard session routes rester séparé
Les clés API sont disponibles uniquement sur les forfaits Professionnel et Entreprise. Les utilisateurs Starter voient une invite de mise à niveau dans les paramètres.

Accès et limites

La surface de tarification annonce les allocations mensuelles d'appels d'API par forfait, tandis que l'API externe en direct applique une limite de requêtes à fenêtre mobile et renvoie des en-têtes de limite de débit à chaque réponse. Gardez ces deux éléments à l'esprit lors de la création de tentatives client et de tableaux de bord de quotas.

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

Dans l'implémentation actuelle, l'API externe renvoie X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset en cas de réponses réussies, plus Retry-After lorsqu'une requête est limitée.

Format d'erreur

Les routes d'API externes renvoient des erreurs JSON structurées avec error.code et error.message. Utilisez le code pour accéder à la gestion des erreurs et au message pour les journaux lisibles par l'homme.

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

Statuts courants

  • 400 Paramètres de requête manquants ou invalides
  • 401 Clé API manquante ou invalide
  • 403 Clé API valide mais le plan n'est pas éligible
  • 404 Canal ou ressource connecté introuvable
  • 429 Limite de débit dépassée
  • 500 Erreur de serveur inattendue

Prêt à construire ?

Inscrivez-vous à un forfait Professionnel ou Entreprise pour obtenir un accès à l'API. Vous avez déjà un compte ? Accédez au tableau de bord pour créer des clés API.