Zum Hauptinhalt springen

Reports API

Overview​

Endpoints for generating and retrieving detailed company reports and analytics. Base path: /api/reports

📊 Company Reports​

Get Company Report​

GET /api/reports/{company_name}

Returns a comprehensive AI-generated report including trust scores, sentiment analysis, rating distribution, and review topics.

Parameters:

  • company_name: The name or slug of the company.
  • region: (Optional) Country code filter (e.g., de, ch, at, global).

Response:

{
  "company_name": "Volkswagen",
  "generated_at": "2023-10-27T10:00:00.000000",
  "trust_score": 82,
  "stats": {
    "avg_rating": 4.2,
    "total_reviews": 15420,
    "trust_score": 82
  },
  "ai_analysis": {
    "EXECUTIVE SUMMARY": "...",
    "DEEP DIVE: CULTURE & MANAGEMENT": "...",
    "COMPENSATION & BENEFITS": "...",
    "WORK-LIFE BALANCE": "...",
    "CAREER DEVELOPMENT": "...",
    "STRATEGIC OUTLOOK": "..."
  },
  "charts_data": {
    "sentiment_distribution": {"positive": 8000, "negative": 2000, "neutral": 5420},
    "rating_distribution": {"5": 6000, "4": 4000, "3": 3000, "2": 1000, "1": 1420},
    "timeline": [{"month": "2023-01", "count": 120}, ...],
    "top_topics": [{"aspect": "Management", "sentiment": "NEGATIVE", "count": 45}, ...]
  }
}

Notes:

  • Automatically resolves company names to slugs using fuzzy matching if an exact match isn't found.
  • If AI analysis is not found in the database, it returns a fallback structured placeholder.