About this endpoint
What it does
Extracts and groups keywords from one or more publicly accessible article URLs. The request sends a list of URLs and optional tuning fields, and the response returns ranked keyword groups.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| urls | String Array | Yes | Publicly accessible article URLs to analyse. Maximum 10; extras are ignored. |
| article_length | Integer | No | Expected article character length hint (optional; helps the parser tune extraction). |
| return_results_top | Integer | No | Maximum number of keyword groups to return (5–50). Omit to return all groups. |
Response
Returns a JSON object with a data field containing keyword extraction results. The response includes an individual_results array with keyword analysis for each processed URL. If aggregation is requested, the aggregated_results field contains the combined analysis; otherwise, it is null.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Wrapper object containing the response payload. |
| data.individual_results | Object Array | Yes | Keyword extraction results for each processed URL. |
| data.individual_results[].url | String | Yes | URL of the processed article or webpage. |
| data.individual_results[].latent_semantic_keywords | String Array | Yes | List of latent semantic (contextually related) keywords extracted from the content. |
| data.individual_results[].high_frequency_keywords | Object Array | Yes | Most frequently occurring keywords with their occurrence counts. |
| data.individual_results[].high_frequency_keywords[].keyword | String | Yes | Extracted keyword. |
| data.individual_results[].high_frequency_keywords[].frequency | Integer | Yes | Number of times the keyword appears in the content. |
| data.individual_results[].high_frequency_keyphrases | Object Array | Yes | Most frequently occurring keyphrases with their occurrence counts. |
| data.individual_results[].high_frequency_keyphrases[].keyphrase | String | Yes | Extracted keyphrase. |
| data.individual_results[].high_frequency_keyphrases[].frequency | Integer | Yes | Number of times the keyphrase appears in the content. |
| data.individual_results[].preview | String | Yes | Short preview of the processed content. |
| data.aggregated_results | Object | Null | Yes | Aggregated keyword extraction results across all processed URLs, or null if aggregation is not available. |