Haloscan icon

Haloscan

Haloscan is a powerful SEO analysis tool that provides insights into keyword rankings, domain metrics, and related searches.

Overview

The 'Get Keyword Highlight' operation in the Keyword Explorer resource identifies keywords for which the same expressions are highlighted in search engine results pages (SERPs). This operation is useful for SEO professionals and marketers who want to analyze keyword highlights to understand keyword prominence and competition in SERPs. For example, it can help identify keywords that share highlighted expressions, aiding in keyword strategy and content optimization.

Use Case Examples

  1. Analyzing keyword highlights to find common expressions in SERPs for a given keyword.
  2. Filtering keyword highlights by similarity, competition, or volume to refine SEO strategies.

Properties

Name Meaning
Keyword The main keyword to analyze for highlighted expressions in SERPs.
Order By Field used for sorting the results, such as by similarity, competition, or volume.
Exact Match Whether to strictly match the seed keyword, ignoring accents, punctuation, case, and special characters when false.
Similarity Max Maximum similarity threshold for filtering results.
Similarity Min Minimum similarity threshold for filtering results.
Page Page number for paginated results.
Line Count Maximum number of results to return.
Additional Fields Additional filtering and sorting options such as include/exclude regex, KGR, KVI, competition, CPC, volume, word count, and order direction.
Request Options Settings for batching, SSL certificate validation, proxy, and request timeout.

Output

JSON

  • data - Array of keyword highlight results with details about highlighted expressions and metrics.

Dependencies

  • An API key credential for authentication with the Haloscan API.

Troubleshooting

  • Ensure the API key credential is correctly configured and has sufficient permissions.
  • Verify that the keyword parameter is provided and valid.
  • Check network connectivity and proxy settings if requests fail.
  • Adjust request timeout and batching settings if experiencing timeouts or rate limits.

Links

Discussion