API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.
APIv3Signal TemplatesParameters by template

Mentioned competitor brand on LinkedIn

Parameters, defaults and rules of the "Mentioned competitor brand on LinkedIn" signal template.

Know when prospects mention a competitor on LinkedIn: posts naming the competitors of your company.

Keymentioned-competitor-brand-on-linkedin
Categorycompetition
Watchesperson
SetupsDiscovery and account monitoring

Set this signal up with POST /v3/signal-setups: send the template's id as signal_template_id and the parameters below in parameters. Its id is in List signal templates. Any parameter not listed here is refused with a 422.

Parameters

ParameterTypeRequiredAllowed valuesDefaultDescription
scopesarray of stringYesdiscovery, account_monitoring (at least one)—Where the signal looks.
keywordsarray of stringNoAt least one keywordThe names of the companies in your competitor lists (see below)The competitor names to look for.

Default is what the server stores when you leave the parameter out. — means there is no default: the parameter is required, or it is simply not set.

Rules

  • When you leave keywords out, the names of the companies in your competitor lists are stored. Archived or deleted competitor lists are ignored. There is no limit on how many.
  • One persona: every company of every competitor list is used.
  • Several personas: the companies of the competitor lists linked to the setup's persona, plus the lists linked to no persona. Pass persona_id when you create the setup.
  • Each company is named by its name when known, otherwise by the first part of its domain (hubspot.co.uk becomes hubspot).
  • Keywords you send always win over the default. Sending keywords: [] is refused.
  • The list and get routes show this default for one persona when you pass persona_id to GET /v3/signal-templates. In a workspace with several personas, without persona_id, this property carries no default. It carries none either when there is no company to name, because the competitor lists are empty.
  • Setting this signal up needs your persona to have at least one job title and one location, otherwise the request is refused with a 422. With several personas, send persona_id when you create the setup (see Create a signal setup).

Errors

A parameter that is missing, of the wrong type, or not an allowed value is refused with a 422 that names it under errors, for example parameters.scopes. These errors are specific to this signal template:

StatusCause
422parameters.keywords is left out and your workspace has no competitor list holding a company. Set up a competitor list first, or add keywords.
422parameters.keywords is empty. Send at least one keyword.
409The signal template is archived.

Example

parameters of a setup:

{
  "scopes": ["account_monitoring"],
  "keywords": ["hubspot", "salesforce"]
}

On this page