Method: POST
Content Type: application/json
Request Body
Attribute | Type | Mandatory | Description |
---|
urls | Array | Yes | Provide URLs of websites from which keywords are to be extracted. The number of URLs should be between 1 and 10 . |
article_length | Number | Yes | Provide word count for the new article. |
return_results_top | Number | No | Provide the number of top keywords, keyphrases, and latent semantic keywords to be returned for both individual and aggregated results. Acceptable values are between 5 and 50 . Defaults to 10 . |
Response
Attribute | Type | Description |
---|
data.aggregated_results | Object | Aggregated results derived from the input URLs and the length of the new article. |
data.aggregated_results.top_keywords | Array | Aggregated top keywords, including their maximum and minimum ranges, for inclusion in the new article. |
data.aggregated_results.top_keywords.keyword | String | A keyword suggested for inclusion in the new article. |
data.aggregated_results.top_keywords.max_range | Number | Maximum suggested range for the frequency of the keyword in the new article. |
data.aggregated_results.top_keywords.min_range | Number | Minimum suggested range for the frequency of the keyword in the new article. |
data.aggregated_results.top_phrases | Array | Aggregated top keyphrases, including their maximum and minimum ranges, for inclusion in the new article. |
data.aggregated_results.top_phrases.phrase | String | A keyphrase suggested for inclusion in the new article. |
data.aggregated_results.top_phrases.max_range | Number | Maximum suggested range for the frequency of the keyphrase in the new article. |
data.aggregated_results.top_phrases.min_range | Number | Minimum suggested range for the frequency of the keyphrase in the new article. |
data.aggregated_results.top_latent_semantic_keywords | Array | Aggregated top latent semantic keywords suggested for inclusion in the new article. |
data.individual_results | Array | Results from the URLs provided by the user. |
data.individual_results.url | String | URL of the user-provided article. |
data.individual_results.preview | String | The initial segment of the user-provided article. |
data.individual_results.high_frequency_keywords | Array | Most frequent keywords in the user-provided article. |
data.individual_results.high_frequency_keywords.keyword | String | A specific keyword found in the user-provided article. |
data.individual_results.high_frequency_keywords.frequency | Number | Frequency count of each keyword in the user-provided article. |
data.individual_results.high_frequency_keyphrases | Array | Most frequent keyphrases in the user-provided article. |
data.individual_results.high_frequency_keyphrases.keyphrase | String | A specific keyphrase found in the user-provided article. |
data.individual_results.high_frequency_keyphrases.frequency | Number | Frequency count of each keyphrase in the user-provided article. |
data.individual_results.latent_semantic_keywords | Array | Latent semantic keywords identified in the user-provided article. |
Sample Response
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|
200 | The request was successful. |
400 | Invalid input - the url is not accessible or the supported inputs are not provided. |
401 | Required authentication information is either missing or not valid for the resource. |
500 | If any unexpected error occurs while processing the request. |