Signal templates
Browse the signals a client can set up, and what each one needs.
A signal template describes one signal a client can set up: what it watches for, who it watches (a person, a company, or both), which setups it supports (Discovery, account monitoring, or both) and what it costs. Each template also lists the parameters a setup for it takes, so you can render or validate a setup form without hard-coding it.
To set a signal up, pick a template here, then call POST /v3/partner/workspaces/{partner_workspace_id}/signal-setups with its id and its parameters (see Create a signal setup).
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/v3/partner/workspaces/{partner_workspace_id}/signal-templates | List a client's signal templates: browse and filter the signal templates. |
| GET | /api/v3/partner/workspaces/{partner_workspace_id}/signal-templates/{signal_template_id} | Get a client's signal template: retrieve one signal template, including an archived one. |
Categories
Every signal template belongs to one category. The category is a key in responses and in the categories filter.
| Key | Signals |
|---|---|
my_properties | Signals about the properties of the workspace. |
my_network | Signals about the network around the workspace: its content, its brand, its partners, its champions. |
competition | Signals about competitors. |
people | Signals about people and hiring. |
market | Signals about the market: keywords, influencers, job offers. |
internal_intents | Signals built on data from the workspace. |
Parameters by template
Each template below has its own page listing every parameter: its type, whether it is required, its allowed values and its Default, plus the rules and errors that apply to it.
| Signal template | Category | Watches | Setups |
|---|---|---|---|
| Engaged with my content on LinkedIn | my_network | person | Discovery and account monitoring |
| Mentioned my brand | my_network | person | Discovery and account monitoring |
| Mentioned competitor brand on LinkedIn | competition | person | Discovery and account monitoring |
| Mentioned keywords on LinkedIn | market | person | Discovery and account monitoring |
| Mentioned keywords in their job offers | market | company | account monitoring |
| Hiring for roles my product serves | people | company | account monitoring |
| Job change | people | person | Discovery and account monitoring |
| Champion joined a new company or promoted | my_network | person | Discovery and account monitoring |
| Engaged with competitors on LinkedIn | competition | person | Discovery and account monitoring |
| Engaged with my partners on LinkedIn | my_network | person | Discovery and account monitoring |
| Engaged with influencers in my space on LinkedIn | market | person | Discovery and account monitoring |
Defaults
Every default shown in a signal template is applied by the server when the setup is created, stored, and returned when you read the setup back. A property you send always wins over its default. A parameter without a default must be sent when it is required.
Some defaults depend on the client's workspace: the client's domain and the names of the client's competitors. The list and get routes show them resolved for one persona when you pass persona_id to the list or get route. A signal belongs to one persona: see Personas. Without persona_id: if the client's workspace has one persona, they are resolved for it; if it has several, they are not shown.
The persona's job titles
Signal templates that look for job titles take use_persona_job_titles, true by default. It adds the job titles of the setup's persona to the ones in job_titles. They are read at each run, never copied into the setup, so the signal follows any later change to the persona. job_titles only holds the titles you send.
Pricing
Each template carries its price in pricing. Account monitoring is priced per key account per month (per_key_account_per_month). Discovery is priced per signal found (signal_found). pricing.account_monitoring and pricing.discovery are each null when the template does not support that setup.
Archived signal templates
An archived signal template is left out of the list, but you can still read it by its ID. Setting one up is refused with a 409.