Reference

Technical specifications and detailed documentation.

Configuration Reference

Complete YAML schema with all available parameters:

  • Project settings - Name, description, output directory

  • Data source - API configuration

  • Queries - Brand definitions (up to 5)

  • Parameters - Geo, date range, granularity

  • Analysis - Metrics, insights, anomaly detection

  • Visualisation - Theme, DPI, chart types

  • Reporting - Output formats, sections

  • Options - Cache, retry, logging

See config.yaml for a complete example.

Metrics Explained

Volatility

Standard deviation of Share of Search values over time. Higher values indicate more erratic search patterns.

Momentum

Rate of change in Share of Search. Positive momentum indicates accelerating interest.

HHI (Herfindahl-Hirschman Index)

Market concentration metric. Ranges from 0 (perfect competition) to 10,000 (monopoly).

HHI = Σ(Share²) for all brands

Output Files

full_data.csv

Complete time series data with columns:

  • date - Observation date

  • query - Brand name

  • value - Raw search interest (0-100)

  • share_of_search - Percentage of total market

metrics.csv

Aggregate statistics per brand:

  • query - Brand name

  • avg_share - Average Share of Search

  • volatility - Search stability metric

  • trend_direction - Rising, stable, or declining

  • total_interest - Sum of all search values

insights.txt

AI-generated analysis (when enabled):

  • Executive summary

  • Anomaly explanations

  • Strategic recommendations

  • Market dynamics

API Documentation

See AutoAPI Reference for complete technical documentation auto-generated from source code.