Signalby Metrics Hive
Start

Analyze a website

POST
/tools/analyze

Run brand analysis without persisting anything. Returns suggested additional domains, aliases, competitors, and prompts.

Requires an instance admin key; organization keys receive 403.

Authorization

BearerAuth
headerAuthorizationBearer <token>

An organization key (signal_…) created under Organization Settings → API Keys.

Request Body

application/json
  1. body
website*string

Brand's website — a hostname or a full URL. A URL with a path (e.g. https://www.nike.com/golf) is analyzed as given; the returned website is always its domain.

Length1 <= length
brandName?string

Optional brand name hint. If omitted, inferred from the domain.

maxCompetitors?integer

Maximum number of competitor suggestions. 0 disables competitor generation entirely.

Range0 <= value <= 100
Default20
maxPrompts?integer

Maximum number of suggested prompts. 0 disables prompt generation entirely.

Range0 <= value <= 100
Default30

Response Body

Brand analysis suggestion

application/json
  1. response
brandName*string
website*string

Cleaned hostname

additionalDomains*array<string>
aliases*array<string>
competitors*array<>
suggestedPrompts*array<>
Example Request
curl -X POST 'https://app.signal.metricshive.com/api/v1/tools/analyze' \
  -H 'Content-Type: application/json' \
  -d '{
  "website": "string"
}'
Example Response
{
  "brandName": "string",
  "website": "string",
  "additionalDomains": [
    "string"
  ],
  "aliases": [
    "string"
  ],
  "competitors": [
    {
      "name": "string",
      "domains": [
        "string"
      ],
      "aliases": [
        "string"
      ]
    }
  ],
  "suggestedPrompts": [
    {
      "prompt": "string",
      "tags": [
        "string"
      ]
    }
  ]
}