Documentation Reference

TubeAnalytics Documentation

This is the canonical technical index for TubeAnalytics. It connects the public marketing site, the authenticated dashboard, the external REST API, and the machine- readable discovery files used by AI systems and internal tooling.

If you need product context, start here. If you need implementation details, use/developersfor API and agent access.

Technical Index

Product Map

TubeAnalytics is split across public marketing pages, the authenticated dashboard, and a machine-readable developer surface. This map shows where each part lives.

AreaPrimary routesWhat lives there
Public docs/docs, /developers, /apiProduct overview, setup, API access, and discovery links
Marketing/features, /pricing, /compare, /aboutPlans, feature summaries, and comparison pages
Dashboard/dashboard/*, /billing, /settingsAnalytics, competitors, thumbnails, reports, revenue, and account settings
External API/api/external/v1/*Authenticated programmatic access to channel, analytics, audience, and competitor data
Agent discovery/openapi.json, /mcp.json, /ai.txt, /ai-pricing.json, /agents.txtMachine-readable discovery for SDKs, agents, and indexers

Getting Started

Quick Start

The fastest path to useful data is: create an account, connect a channel, let the initial sync complete, and then open the dashboard or developer surface that matches your use case.

  1. Sign up at tubeanalytics.net.
  2. Connect your YouTube channel with Google OAuth.
  3. Grant the scopes required by the features you plan to use.
  4. Wait for the first sync, then open the analytics or competitors dashboard.
  5. If you are building software, review /developers and /openapi.json next.
Shell
Quick start flow
1. Visit tubeanalytics.net
2. Click Get started
3. Sign in with Google
4. Approve the required permissions
5. Review the first sync on the dashboard
6. Open /developers if you need API keys or agent docs

Getting Started

Connecting Your Channel

TubeAnalytics uses Google OAuth 2.0 to connect a channel safely. The platform requests only the scopes it needs to read channel data, pull analytics, and power comments moderation when the feature is enabled.

ScopePurposeFeature
youtube.readonlyRead channel and video metadataDashboard, competitor benchmarking, analytics surfaces
yt-analytics.readonlyAccess YouTube Analytics dataChannel analytics, video performance, revenue reporting
youtube.force-sslRead and manage comments securelyComments Manager

Getting Started

Dashboard Overview

The dashboard is organized around the questions creators ask first: how the channel is growing, which videos are winning, which competitors matter, and how revenue is changing. The implementation is split across route groups such as `/dashboard/analytics`, `/dashboard/competitors`, `/dashboard/thumbnails`, `/dashboard/reports`, and `/dashboard/settings`.

RouteWhat it showsWhy it matters
/dashboard/analyticsChannel summary, growth, viewer behavior, and traffic sourcesThis is the default place to answer 'how is the channel doing?'
/dashboard/competitorsTracked competitors, comparison charts, and gap analysisMakes competitor benchmarking part of the working set, not a side task
/dashboard/thumbnailsThumbnail tests, quick wins, and correlation historyKeeps CTR optimization tied to the same account and channel context
/dashboard/reportsPDF reports and schedulesSupports recurring exports and client-facing reporting

Core Features

Competitor Benchmarking

Competitor benchmarking is the flagship TubeAnalytics workflow. Add competitor channels by URL or search, then compare public metrics such as subscriber count, upload frequency, average views per video, and estimated RPM range. The public compare pages live under `/compare` and the in-app workflow lives under the competitor dashboard.

Charts help you compare growth and pacing, while export options make it easy to share a competitor summary with a teammate or client. The goal is not just to view numbers, but to answer what your next move should be. The public comparison pages are the human summary, while the dashboard and API hold the working data.

StepWhat happensOutput
Add a competitorPaste a channel URL or search for a channelTracked competitor profile
Sync metricsTubeAnalytics fetches public channel signalsBenchmark data and comparison charts
Review the gapCompare your channel against the competitorActionable insight on pace, scale, and format
ExportShare the report as CSV or screenshot-ready outputInternal or client-ready artifact

Core Features

Revenue Tracking

Revenue tracking unifies ad revenue and non-AdSense income into a single view. The dashboard routes under `/dashboard/billing` and `/dashboard/monetization/optimization` show revenue context, while the API surfaces the same concepts under `/api/v1/channels/:channelId/revenue` and `/api/v1/channels/:channelId/cpm-analysis`.

SourceIngestion methodNotes
AdSenseAuthenticated analytics pullBacked by the connected channel and synced automatically
Channel membershipsAuthenticated analytics pullAppears in the unified monthly, weekly, or daily chart
Super ChatsAuthenticated analytics pullUseful for livestream-heavy channels
Merchandise / sponsorships / affiliateManual entryManual sources are still important, so the dashboard keeps them visible

Core Features

AI Content Insights

AI Content Insights generates title suggestions, thumbnail feedback, tag recommendations, and a performance prediction score. The connected experience spans the dashboard, `/api/v1/ai/generate-ideas`, the thumbnail tooling, and the machine-readable discovery files used by AI clients.

The output is designed to be actionable. A recommendation should point to a change you can make on the next upload, not just a generalized observation about the channel. Trend detection and competitor analysis feed the same decision layer.

Core Features

Viral Script Generator

The Viral Script Generator streams completions from the `gpt-4.1` model for creating long-form YouTube scripts. Users choose a topic, target audience, desired length, and a virality framework such as hook-story-offer, listicle, or challenge format.

InputPurposeExample
TopicDefines the core ideaYouTube competitor analysis
Target audienceShapes tone and examplesCreators with 10k-100k subscribers
Video lengthControls pacing and script depth8 minutes
FrameworkGuides structureHook-story-offer
JSON
Example script request
{
  "topic": "How to benchmark competitors",
  "targetAudience": "YouTube creators",
  "videoLengthMinutes": 8,
  "framework": "listicle"
}

Core Features

Comments Manager

Comments Manager gives you one unified inbox for all videos. It uses the YouTube OAuth 2.0 permission set that includes `youtube.force-ssl`, so the platform can view, reply, approve, hold, delete, and flag comments for follow-up.

CapabilityBehaviorWhy it matters
Unified inboxShows comments across all videos in one placeReduces context switching
FiltersFilter by video, date, or sentimentHelps you prioritize the comments that need attention
Bulk moderationApprove, hold, or delete in batchesSaves time on large comment spikes
Follow-up flagsMark comments for later actionKeeps high-value responses from being forgotten

Analytics

Analytics Reference

This section defines the core analytics concepts available across the dashboard and API. Each metric is documented with what it measures and what action it supports.

Channel Analytics

MetricDefinitionWhy it matters
Subscriber growthHow fast the audience is growing over timeShows whether the channel is compounding
Watch timeTotal minutes watched in the selected date rangeSignals how much attention the channel is earning
CTRClick-through rate, or impressions that became viewsMeasures packaging quality
Traffic sourcesWhere views are coming fromExplains which surfaces are driving discovery

Video Performance

Video Performance is a sortable table of every video with the metrics most creators use to make decisions: views, watch time, CTR, average view duration, estimated revenue, and the AI performance score.

ColumnMeaningAction
TitleThe video nameUse it to spot packaging patterns
Publish dateWhen the video went liveCompare performance against freshness
AI performance scoreModel-generated score that predicts relative strengthUse it as a directional signal, not a promise

Audience Insights

Audience Insights breaks down age and gender, geography, device type, and traffic source. Charts include bar charts and geography views so you can tell not only who watches, but where and on what device they watch from.

Revenue Breakdown

Revenue Breakdown lets you inspect revenue by stream, by video, and by time period. Use it to compare RPM and CPM, spot top earning videos, and understand how much of your monthly income comes from each monetization source.

TermMeaningInterpretation
RPMRevenue per 1,000 views after YouTube's shareShows actual earnings efficiency per view
CPMRevenue per 1,000 impressions before creator shareShows ad demand and audience value
Manual revenueSponsorships, merch, and affiliates entered by handKeeps non-AdSense income visible in the total

Integrations

YouTube Data API

TubeAnalytics uses YouTube Data API v3 endpoints to power connected channel workflows. The app reads channel metadata, video lists, search results, comments, and analytics reports on behalf of the signed-in user.

EndpointPurposeNotes
channels.listChannel metadataUsed for connected channel info
videos.listVideo metadataUsed in video tables and detail views
search.listSearch discoveryUsed for finding competitors or content ideas
commentThreadsCommentsUsed by Comments Manager
analytics/reportsAnalyticsUsed for channel and revenue reporting

Integrations

Webhook Flows

Webhooks keep the account and billing state in sync. The current implementation uses a Clerk webhook for user lifecycle events and a Creem webhook for checkout and subscription events, with the database as the source of truth.

JSON
Clerk: user.created
{
  "type": "user.created",
  "data": {
    "id": "user_123",
    "primary_email_address_id": "idn_456",
    "email_addresses": [{ "id": "idn_456", "email_address": "creator@example.com" }],
    "first_name": "Mia",
    "last_name": "Lopez"
  }
}
JSON
Creem: checkout.completed
{
  "type": "checkout.completed",
  "customer": { "id": "cust_123" },
  "subscription": {
    "id": "sub_123",
    "current_period_start_date": "2026-05-25T00:00:00Z",
    "current_period_end_date": "2026-06-25T00:00:00Z"
  },
  "metadata": { "userId": "user_123" }
}
JSON
Creem: subscription.paid
{
  "type": "subscription.paid",
  "id": "sub_123",
  "last_transaction": {
    "id": "txn_123",
    "amount": 4900,
    "currency": "USD"
  }
}
JSON
Creem: subscription.canceled
{
  "type": "subscription.canceled",
  "id": "sub_123",
  "metadata": { "userId": "user_123" }
}

Developer

Discovery & Agents

These are the machine-readable files the codebase keeps current for agent tooling, documentation generators, and integration checks. If you are building with AI clients or verifying the product surface, start here.

FilePurposeWhen to use it
/openapi.jsonOpenAPI 3.1 contract for the external APIGenerate clients, validate schemas, or inspect endpoints
/mcp.jsonModel Context Protocol manifestConnect agents to the streamable HTTP transport
/ai.txtDiscovery and crawler guidanceTell AI systems what to index, summarize, and avoid
/ai-pricing.jsonMachine-readable product and pricing manifestBuild checkout-aware assistants and pricing tools
/agents.txtConcise agent indexQuickly discover the main AI-facing surfaces
/llms.txtPublic content index for LLM retrievalPull the canonical public pages without scraping
/pricing.mdPlain-text pricing for AI agents and LLMsProgrammatic plan comparison without JS rendering

Account & Billing

Plans & Pricing

TubeAnalytics offers three tiers with a 7-day free trial and plan limits backed by the product contract. See the pricing page for full details.

PlanPriceChannelsCompetitorsAPI calls/mo
Starter$19/mo1 channel51,000
Professional$49/mo3 channels105,000
Enterprise$149/mo5 channels2020,000

Account & Billing

Subscription Management

Billing is handled through Creem. From the billing area you can update payment details, view invoices, pause a subscription, or cancel it. Cancellation takes effect at the end of the current billing period.

Account & Billing

API Keys

API keys let users access TubeAnalytics programmatically. Create a key from the account settings page, choose a scope, and copy the token once. You can revoke keys at any time.

HTTP
Authorization header
Authorization: Bearer <token>

Account & Billing

Team Access

Professional and Enterprise plans support team members. Invite someone by email, assign a role, and remove access when they no longer need it.

RolePermissions
AdminManage channels, competitors, billing, API keys, and team access
AnalystView analytics, competitors, revenue, scripts, and exports
ViewerRead-only access to dashboards, reports, and docs-linked resources

Developer

API Reference

The external API is documented in full on the /developers page with authentication, error codes, rate limits, and curl examples.

Base URL: https://tubeanalytics.net/api/external/v1

MethodEndpointDescription
GET/channelsList connected channels
GET/channels/:channelIdFetch one connected channel
GET/analytics?channel_id=...Aggregated channel analytics
GET/videos?channel_id=...Paginated video list
GET/audience?channel_id=...Audience demographics
GET/competitorsTracked competitors

Developer

Rate Limits

Rate limits depend on plan tier. The signed-in API key path is available on Professional and Enterprise plans, while Starter users do not get external API access. The codebase enforces a sliding-window limit on key-auth requests, and the response headers include `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`.

HeaderMeaning
X-RateLimit-LimitMaximum requests allowed in the current window
X-RateLimit-RemainingRequests left before you hit the limit
X-RateLimit-ResetUnix timestamp when the window resets

Developer

SDKs & Libraries

A JavaScript / TypeScript SDK is planned, and a Python SDK is on the roadmap. Until the SDK ships, you can call the REST API directly from fetch or your preferred HTTP client.

TypeScript
Fetch example
const response = await fetch("https://tubeanalytics.net/api/external/v1/channels", {
  headers: {
    Authorization: "Bearer <token>",
  },
});

const data = await response.json();

Developer

Changelog

See the full changelog for the complete release history. Recent releases:

v1.4.0May 2026Viral Script Generator, advanced AI streaming
v1.3.0Apr 2026Creem payments integration, 7-day trial
v1.2.0Mar 2026Comments Manager, YouTube OAuth v2
v1.1.0Feb 2026i18n support (6 languages), theme switcher
v1.0.0Jan 2026Initial launch: analytics, competitor benchmarking, revenue tracking

Support

FAQ

TubeAnalytics requests only the scopes required to read channel data, pull analytics, and support comments moderation. Each scope is tied to a real feature, so the consent screen looks broader than a single dashboard page but still remains limited to the product's actual workflows.
Refresh cadence depends on the source. Some dashboard data syncs quickly after connection, while other views update on the cadence of the connected API source or the user's refresh action.
Yes, competitor benchmarking is designed for public channel analysis. TubeAnalytics uses public metrics where available and compares them against your own channel data for context.
No. Revenue data is tied to your account and used to render your dashboards, reports, and exports. It is not shared with other creators.
Cancellation remains active until the end of your billing period. After that point, paid access ends and the account returns to the plan state defined by the product rules.
Yes, but some audience insights may be limited because YouTube applies threshold rules to certain demographic reports. The rest of the product still works normally.
There is no separate AI credit wallet in the current codebase. AI features are governed by the plan allowances in the pricing contract, and specific endpoints also enforce route-level limits such as monthly API usage or per-route throttles.

Support

Contact Support

Email support at support@tubeanalytics.net. Response time is within 24 hours on business days.

Send a Message

By submitting this form, you agree to our privacy policy.

Support

Community

Join the TubeAnalytics Discord community to compare workflows, share feature requests, and ask other creators how they are using analytics, competitor benchmarking, and AI tools in practice.

discord.gg/tubeanalytics