entities

Set an entity's aliases, domains, exclusions and context terms

The desired state. The server diffs against the current rows: what is gone is closed as of now, what is new is added, what is unchanged is untouched. A run executed yesterday still resolves against yesterday's aliases. Works for the self entity too. A generic name cannot have its context terms removed, and a generic alias is refused without them.

put/entities/{entityId}

Request

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

Request body

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.

Response

The entity as it now is.

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.