entities

Add a competitor

Competitors only; the self entity comes with the brand.

Aliases are exact strings matched on token boundaries — no patterns, no fuzzy matching. The name is always one of them; aliases adds other spellings ("Beta List" for BetaList). A given alias equal to the name in any case stands for it, so a case-sensitive acronym stays case-sensitive.

Short or common-word names need context terms. A name or alias of six characters or fewer, or an ordinary English word ("Arc", "Linear", "Notion"), matches sentences that are not about the company. Such an entity is refused with 422 context_terms_required until contextTerms is given, and details.spelling names the spelling; a mention then counts only when one of the terms appears nearby.

post/brands/{brandId}/entities

Request

  • Base URL: https://shruwd.io/api/v1
  • URL: https://shruwd.io/api/v1/brands/{brandId}/entities
  • Auth: HTTP bearer

Request body

namestring required
domainsstring[]

Hosts or URLs; reduced to registrable domains. A citation of one of them counts for this entity.

exclusionsstring[]

Literal phrases that contain an alias but are not the entity ("arc welding" for "Arc").

contextTermsstring[]

When non-empty, a mention counts only if one of these appears nearby. Required for short or common-word names. The entity's domains are added to them.

Example request

{
  "name": "Planwell"
}

Response

Created.

entityIdstring required
namestring required
isSelfboolean required

True for the brand itself.

requiresContextboolean required

Mentions count only near one of contextTerms.

needsContextTermsboolean required

The name or an alias is six characters or fewer or an ordinary English word, so the entity needs context terms to count only real mentions. True with requiresContext false means the entity is matching without them; set some with PUT /entities/{entityId}, or remove the alias.

genericSpellingstring nullable required

The spelling, name or alias, that makes needsContextTerms true; null when none does.

contextTermsstring[] required
domainsstring[] required
exclusionsstring[] required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.