About this endpoint
What it does
Identifies competitors for a given website URL and returns an analysis object describing the analyzed URL, subscription tier, timestamp, and market analysis details.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The website URL for which competitors will be identified. Must be a URI. |
Response
Returns a JSON object with url and tier string fields, a timestamp string field in date-time format, and a marketAnalysis object field containing industry, competitors, market niche, and differentiation strategy details.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The analyzed URL. Must be a URI. |
| tier | String | No | Subscription tier associated with the response detail level. |
| timestamp | String | No | Timestamp when the analysis was generated. Date-time format. |
| marketAnalysis | Object | No | Market analysis details. Includes industry, competitors, marketNiche, and differentiationStrategy. |
| marketAnalysis.industry | String | No | The broad industry classification of the analyzed business. |
| marketAnalysis.competitors | Object Array | No | List of identified competitors. Each item includes name, reason, and likelyOverlap. |
| marketAnalysis.competitors[].name | String | No | Name of the identified competitor. |
| marketAnalysis.competitors[].reason | String | No | Explanation of why this entity is considered a competitor. |
| marketAnalysis.competitors[].likelyOverlap | Integer | No | Estimated percentage overlap in target market/audience. Minimum 0, maximum 100. |
| marketAnalysis.marketNiche | String | No | The specific market niche the business operates in. |
| marketAnalysis.differentiationStrategy | String | No | Suggested strategy for differentiating from competitors. |