Optimizely SEO API

Welcome to the Optimizely SEO API documentation. This API provides powerful tools for optimizing your website's SEO through detailed analysis and suggestions. Below you will find detailed information on the available endpoints and their responses.

Endpoints

Meta Tags Suggestions 🏷️

Endpoint: POST /api/meta-tags/optimize

Optimize your website's meta tags with our suggestions.

Example Request:

POST http://localhost:3000/api/meta-tags/optimize
Content-Type: application/json

{
  "url": "https://londonvetclinic.co.uk/"
}

Response:

{
  "title": "Top Vets in London | Premium Pet Care at London Vet Clinic",
  "metaDescription": "Experience comprehensive, personalized pet care in a friendly environment at London Vet Clinic in Marylebone, West London. Book longer appointments today!",
  "headers": {
    "h1": [
      "Personalized Pet Care at London Vet Clinic",
      "Comprehensive Animal Care in West London"
    ],
    "h2": [
      "Independent Veterinary Practice in Marylebone",
      "Premium Pet Care in the Heart of London",
      "Meet the London Vet Clinic Team",
      "New Clients Welcome",
      "About London Vet Clinic",
      "Our Veterinary Services",
      "Client Reviews"
    ],
    "h3": [
      "Register Your Pet Today",
      "Request Your Pet's Clinical Records"
    ]
  }
}

Meta Analysis 📊

Endpoint: POST /api/meta-analysis/analyze

Analyze the meta tags and heading structure of a webpage.

Example Request:

POST http://localhost:3000/api/meta-analysis/analyze
Content-Type: application/json
{
  "url": "https://londonvetclinic.co.uk/"
}

Response:

{
  "metaTags": {
    "title": "Vets In London | Vets In West London | London Vet Clinic : London Vet Clinic",
    "titleLength": 76,
    "isTitleLengthValid": false,
    "metaDescription": "At the London Vet Clinic you'll find longer than typical appointments in a pet-friendly environment so we can provide personalised pet care for you and your pet.",
    "descriptionLength": 161,
    "isDescriptionLengthValid": false
  },
  "headingStructure": {
    "headings": [
      {
        "tag": "h1",
        "text": "At the London Vet Clinic we admire and respect animals as individuals"
      },
      {
        "tag": "h2",
        "text": "We are an independent, premium care general practice established for over 50 years in Marylebone in the heart of London"
      },
      {
        "tag": "h1",
        "text": "At the London Vet Clinic we enjoy animals as individuals"
      },
      {
        "tag": "h2",
        "text": "We are a multi-vet, independent, premium care general practice established for 50 years in the heart of London"
      },
      {
        "tag": "h2",
        "text": "Welcome to the London Vet Clinic"
      },
      {
        "tag": "h2",
        "text": "We welcome new clients"
      },
      {
        "tag": "h3",
        "text": "Fill out a Pet Registration form"
      },
      {
        "tag": "h3",
        "text": "Please ask your previous veterinary clinic to email your pet’s clinical record to hello@londonvetclinic.co.uk"
      },
      {
        "tag": "h2",
        "text": "Who We Are"
      },
      {
        "tag": "h2",
        "text": "Our Services"
      },
      {
        "tag": "h2",
        "text": "Reviews"
      }
    ],
    "isHeadingStructureValid": true
  }
}

Business Review Analysis 📈

Endpoint: POST /api/review-analysis/analyze

Analyze business reviews to extract insights and improvement suggestions.

Example Request:

POST http://localhost:3000/api/review-analysis/analyze
Content-Type: application/json

{
  "address": "Via Pietro Bembo, 30, 30172 Venezia VE, Italy",
  "city": "Venice",
  "country": "Italy",
  "zipCode": "30172",
  "name": "Hostaria Vite Rossa"
}

Response:

{
  "suggestedResponse": "Dear valued customers, thank you for your feedback and for choosing Hostaria Vite Rossa. We are thrilled to hear that you enjoyed our vibrant ambiance and delicious dishes. We apologize for any delays in service and are actively implementing measures to enhance our wait times. Our team is also working on improving the vegetarian menu options based on your suggestions. Your comments are incredibly important to us, and we are dedicated to making each dining experience exceptional. We look forward to welcoming you back soon. Sincerely, The Hostaria Vite Rossa Team.",
  "improvements": [
    "Enhance wait times by hiring additional staff or improving kitchen workflow",
    "Increase vegetarian and vegan menu options",
    "Improve staff training to ensure consistent service quality"
  ],
  "flaws": [
    "Lengthy wait times for orders",
    "Limited vegetarian and vegan options",
    "Occasional inconsistencies in the quality of service"
  ],
  "strengths": [
    "Vibrant and welcoming ambiance",
    "High-quality and delicious dishes",
    "Friendly and attentive staff"
  ]
}

Link Checker 🔗

Endpoint: POST /api/link-checker/check-links

Check a webpage for broken links and redirects.

Example Request:

POST http://localhost:3000/api/link-checker/check-links
Content-Type: application/json
{
  "url": "https://londonvetclinic.co.uk/"
}

Response:

{
  "redirects": [
    {
      "link": "https://vethelpdirect.com/vet/london-vet-clinic-in-6927"
    },
    {
      "link": "https://londonvetclinic.co.uk/?page_id=131"
    }
  ],
  "brokenLinks": [],
  "redirectsCount": 10,
  "brokenLinksCount": 0,
  "backlinksCount": 54,
  "suggestions": {
    "https://londonvetclinic.co.uk/who-we-are/your-vets/": "Avoid replication of the link.",
    "https://londonvetclinic.co.uk/?page_id=120": "Avoid replication of the link.",
    "https://londonvetclinic.co.uk/?page_id=133": "Avoid replication of the link.",
    "https://londonvetclinic.co.uk/pet-registration/": "Avoid replication of the link.",
    "https://londonvetclinic.co.uk/contact-us/": "Avoid replication of the link."
  }
}

Keyword Analysis 🔍

Endpoint: POST /api/keywords/analyze

Analyze keywords for SEO optimization and insights.

Example Request:

POST http://localhost:3000/api/keywords/analyze
Content-Type: application/json

{
  "url": "https://londonvetclinic.co.uk/",
  "keyword": "pet"
}

Response:

{
  "keyword": {
    "value": "pet",
    "count": 30,
    "density": 2.24,
    "synonyms": [
      "animal companion",
      "domestic animal",
      "pet animal",
      "companion animal"
    ],
    "competitorAnalysis": {
      "topCompetitors": [
        "petvetclinic.com",
        "mypetcare.com"
      ],
      "suggestions": "Target specific pet-related services such as 'pet health tips' and 'emergency pet care'."
    },
    "contentSuggestions": [
      "Detail the benefits of regular pet check-ups.",
      "Provide tips for first-time pet owners."
    ],
    "semanticRelevance": 0.85,
    "userIntent": "informational",
    "keywordPosition": {
      "title": true,
      "headers": true,
      "body": true
    },
    "sentimentAnalysis": {
      "score": 0.9,
      "tone": "positive"
    },
    "roiPotential": {
      "estimatedTrafficIncrease": 1000,
      "conversionRate": 2.5
    }
  }
}

Image Analysis 🖼️

Endpoint: POST /api/image-analysis/analyze

Analyze images on a webpage for SEO optimization.

Example Request:

POST http://localhost:3000/api/image-analysis/analyze
Content-Type: application/json

{
  "url": "https://londonvetclinic.co.uk/"
}

Response:

{
  "totalImages": 45,
  "brokenImages": 18,
  "brokenImageUrls": [
    "https://londonvetclinic.co.uk/wp-content/uploads/2022/10/hero3.jpg",
    "https://londonvetclinic.co.uk/wp-content/uploads/2022/11/xmas.jpg"
  ],
  "imagesWithoutAlt": [
    "https://londonvetclinic.co.uk/wp-content/uploads/2022/10/hero2.jpg",
    "https://londonvetclinic.co.uk/wp-content/uploads/2022/10/hero1.jpg"
  ],
  "imagesWithoutAltCount": 20
}

Price Tracking 💲

Endpoint: POST /api/price-tracking/track

Track competitor pricing for a product.

Example Request:

POST http://localhost:3000/api/price-tracking/track
Content-Type: application/json

{
  "productName": "Apple iPhone 14 Pro",
  "competitors": [
    {
      "name": "Amazon",
      "url": "https://www.amazon.com/dp/B0BC5SPXT3"
    },
    {
      "name": "Best Buy",
      "url": "https://www.bestbuy.com/site/apple-iphone-14-pro"
    },
    {
      "name": "Walmart",
      "url": "https://www.walmart.com/ip/Apple-iPhone-14-Pro"
    },
    {
      "name": "Target",
      "url": "https://www.target.com/p/apple-iphone-14-pro"
    }
  ]
}

Response:

{
  "pricingStrategies": [
    "Competitive Pricing",
    "Value-Based Pricing"
  ],
  "recommendedPriceRange": {
    "min": 60,
    "max": 135
  },
  "competitorAnalysis": [
    {
      "name": "Amazon",
      "price": 117.62554873669143,
      "url": "https://www.amazon.com/dp/B0BC5SPXT3",
      "strategy": "Mid-range pricing, likely balancing between affordability and brand reputation."
    },
    {
      "name": "Best Buy",
      "price": 134.01817044942783,
      "url": "https://www.bestbuy.com/site/apple-iphone-14-pro",
      "strategy": "High pricing strategy, likely focusing on brand trust and additional in-store services."
    },
    {
      "name": "Walmart",
      "price": 144.02193477057756,
      "url": "https://www.walmart.com/ip/Apple-iPhone-14-Pro",
      "strategy": "Premium pricing strategy, possibly leveraging their broad customer base and in-store pickup options."
    },
    {
      "name": "Target",
      "price": 62.25084331685436,
      "url": "https://www.target.com/p/apple-iphone-14-pro",
      "strategy": "Lowest pricing strategy to attract price-sensitive customers."
    }
  ],
  "insights": [
    "Target's extremely low price may indicate promotional pricing or an error. Ensure to verify the legitimacy before making pricing decisions.",
    "Amazon and Best Buy are adopting more balanced, value-focused pricing strategies, likely to appeal to a broader audience.",
    "Walmart's high price suggests a strategy focusing on premium customer segments. Consider whether your target market can sustain a similar price point.",
    "Offering value-added services such as extended warranties, trade-in programs, or exclusive deals could justify a higher price point closer to Best Buy or Walmart."
  ]
}

Support

For further assistance, please refer to our FAQ or Contact Support.