About this endpoint
What it does
Analyzes the content at a given URL and returns keyword, sentiment, readability, and technical metadata about that page. You send a URL in the request body and receive a JSON object describing the analyzed URL and the extracted analysis results.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The website URL to analyze content from. Must be a valid URI. |
Response
Returns a JSON object with top-level url and tier string fields, plus analysis and technical objects. The analysis object contains keywords, sentiment, and readability; the technical object contains language and wordCount.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The analyzed URL. Must be a valid URI. |
| tier | String | No | Subscription tier associated with the response detail level. |
| analysis | Object | No | Analysis results, including keywords, sentiment, and readability. |
| analysis.keywords | Object Array | No | List of extracted keywords ranked by relevance score. |
| analysis.keywords[].term | String | No | The extracted keyword or key phrase. |
| analysis.keywords[].score | Integer | No | Relevance score of the keyword within the content. Range: 0 to 100. |
| analysis.sentiment | String | No | Overall sentiment detected in the content. |
| analysis.readability | Object | No | Readability results, including tone, level, and score. |
| analysis.readability.tone | String | No | Overall tone of the content. |
| analysis.readability.level | String | No | Qualitative readability level. |
| analysis.readability.score | Integer | No | Numeric readability score. Range: 0 to 100. |
| technical | Object | No | Technical metadata about the analyzed page. |
| technical.language | String | No | Detected language/locale of the content. |
| technical.wordCount | Integer | No | Total number of words analyzed on the page. |