Share of Search Documentation (Version 4.0.0)
Share of Search Documentation¶
Welcome to Share of Search
A professional library for competitive intelligence through Share of Search analysis using Google Trends data.
Key Features: Google Trends integration • Share of Search metrics • Statistical analysis
Documentation Sections¶
New to Share of Search? Start here for installation, configuration, and running your first analysis.
Perfect for: First-time users, quick setup
Step-by-step guides for configuration, running analyses, interpreting results, and generating reports.
Perfect for: Completing specific tasks
Real-world case studies with complete code, data, and outputs from actual analyses.
Perfect for: Learning by example
Complete technical documentation auto-generated from source code docstrings.
Perfect for: Detailed specifications
Configuration schemas, output file formats, metrics explanations, and technical details.
Perfect for: Technical specifications
Solutions for common errors, debugging strategies, and frequently asked questions.
Perfect for: Solving problems
Share of Search Workflow¶
graph LR
A[Configure YAML] --> B[Fetch Google Trends Data]
B --> C[Transform & Calculate]
C --> D[Generate Visualisations]
D --> E[AI Insights]
E --> F[PowerPoint Report]
style A fill:#A3C4D9,stroke:#003366,stroke-width:2px
style B fill:#F0F8FF,stroke:#003366,stroke-width:2px
style C fill:#F0F8FF,stroke:#003366,stroke-width:2px
style D fill:#E8F5E9,stroke:#00A86B,stroke-width:2px
style E fill:#E8F5E9,stroke:#00A86B,stroke-width:2px
style F fill:#C8E6C9,stroke:#00A86B,stroke-width:2px
Quick Example¶
# Run a complete analysis
python runme.py
# Or use programmatically
from src.pipeline.orchestrator import run_pipeline
from pathlib import Path
results = run_pipeline(config_path=Path("config.yaml"))
What is Share of Search?¶
Share of Search is a competitive intelligence metric that measures the percentage of total search interest captured by each brand in your market. It’s calculated from Google Trends data and provides insights into:
Market position - Who dominates search interest?
Trends over time - Are brands rising or falling?
Volatility - How stable is search interest?
Anomalies - When did unusual spikes/drops occur?
Market concentration - How competitive is the market?
Key Features¶
Google Trends Integration
Automated data collection via SerpAPI with rate limiting, retry logic, and error handling.
Statistical Analysis
Share of Search, volatility, momentum, trend detection, anomaly identification, HHI calculation.
LLM-Powered Insights
Agentic executive summaries, anomaly explanations, and strategic recommendations.
PowerPoint Reports
PowerPoint presentations with branded visualisations ready for executive briefings.
Scientific Integrity¶
All analyses include:
Measurement error acknowledgement (±5% Google Trends variability)
Correlation vs causation language
Academic citations (Choi & Varian 2012, Cebrián & Domenech 2023)
External validation requirements for hypotheses
Data quality warnings and limitations
Output Examples¶
Generated files:
full_data.csv- Complete time seriesmetrics.csv- Aggregate statisticsinsights.txt- AI-generated analysis*.png- Professional charts (McKinsey style)*_presentation.pptx- Executive PowerPoint deck
Documentation Structure¶
Getting Started: Installation, configuration, first analysis
User Guides: Task-oriented guides for specific objectives
Examples: Real-world case studies with complete code
API Reference: Auto-generated technical documentation
Reference: Configuration schema, metrics, output formats
Troubleshooting: Problem-solving and debugging
About This Documentation¶
Practitioners: Start with Getting Started → Quickstart, then run
python runme.py.Engineers: See User Guides and API Reference.
Analysts: Refer to Output Files and Interpreting Results.