APIv3
Signals
Search, count, read and delete the signal detections published for your workspace.
A signal detection is one match found by a signal: a keyword in a post, a champion changing job, a person engaging with a competitor. Detections are produced by the signal setups of your workspace, and are read here.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /api/v3/signals/query | Query signal detections: page through detections with filters. |
| POST | /api/v3/signals/count | Count signal detections: the total number of detections matching the same filters. |
| GET | /api/v3/signals/{signal_id} | Get a signal detection: retrieve one detection by ID. |
| DELETE | /api/v3/signals/{signal_id} | Delete a signal detection: remove one detection. |
How signal detections read
- Searches page by cursor. Send
cursorandlimit; each response carriesmeta.cursor.nextandmeta.cursor.has_more. See Query signal detections. - Company filters add up. A detection matches when its company is any of the IDs, domains, handles or URLs you send. See Company filters.
- Date filters include their bounds.
signal_date_from,signal_date_to,detected_at_fromanddetected_at_totake a full ISO 8601 date and time. See Dates. signal_typeis written in snake_case. The complete list is below.detailsholds the payload. Its shape depends onsignal_type.- Searches and counts return top-priority detections. They return the detections rated top priority, the ones shown in the app. A detection read by ID may not appear in a search.
- A count takes the body of the query.
POSTthe same filters, withoutcursorandlimit.
Signal types
signal_type is one of the values below on every detection, and the signal_types filter takes the same values. Each row says what happened and which signal template produces it.
| Value | What happened | Produced by |
|---|---|---|
keyword_detection | A post mentions one of the keywords of the setup. | Mentioned my brand, Mentioned competitor brand on LinkedIn, Mentioned keywords on LinkedIn |
job_posting_keyword_detection | A job offer at one of the client's accounts matches the keywords or job titles of the setup. | Mentioned keywords in their job offers, Hiring for roles my product serves |
new_job | A person started a new job. | Job change |
recently_promoted | A person was promoted. | Job change |
champion_job_change | A champion changed company or role. | Champion joined a new company or promoted |
lead_liked_own_content | A person liked a post by your company or one of the client's employees. | Engaged with my content on LinkedIn |
lead_commented_own_content | A person commented on a post by your company or one of the client's employees. | Engaged with my content on LinkedIn |
lead_liked_competitor_content | A person liked a post by someone at a competitor. | Engaged with competitors on LinkedIn (Discovery) |
lead_commented_competitor_content | A person commented on a post by someone at a competitor. | Engaged with competitors on LinkedIn (Discovery) |
linkedin_comment | Someone at a competitor commented on a post by a person who becomes the client's lead. | Engaged with competitors on LinkedIn (Discovery) |
linkedin_reaction | Someone at a competitor reacted to a post by a person who becomes the client's lead. | Engaged with competitors on LinkedIn (Discovery) |
partner_staff_comment | Someone at a partner commented on a post by a person who becomes the client's lead. | Engaged with my partners on LinkedIn (Discovery) |
partner_staff_reaction | Someone at a partner reacted to a post by a person who becomes the client's lead. | Engaged with my partners on LinkedIn (Discovery) |
lead_liked_partner_content | A person liked a post published by a partner. | Engaged with my partners on LinkedIn (Discovery) |
lead_commented_partner_content | A person commented on a post published by a partner. | Engaged with my partners on LinkedIn (Discovery) |
lead_liked_influencer_content | A person liked a post by an influencer of the client's list. | Engaged with influencers in my space on LinkedIn (Discovery) |
lead_commented_influencer_content | A person commented on a post by an influencer of the client's list. | Engaged with influencers in my space on LinkedIn (Discovery) |
competitor_inbound_comment | Someone from the competitor list commented on a post by a person at one of the client's accounts. | Engaged with competitors on LinkedIn (account monitoring) |
competitor_outbound_comment | A person at one of the client's accounts commented on a post by someone from the competitor list. | Engaged with competitors on LinkedIn (account monitoring) |
partner_inbound_comment | Someone from the partner list commented on a post by a person at one of the client's accounts. | Engaged with my partners on LinkedIn (account monitoring) |
partner_outbound_comment | A person at one of the client's accounts commented on a post by someone from the partner list. | Engaged with my partners on LinkedIn (account monitoring) |
influencer_inbound_comment | Someone from the influencer list commented on a post by a person at one of the client's accounts. | Engaged with influencers in my space on LinkedIn (account monitoring) |
influencer_outbound_comment | A person at one of the client's accounts commented on a post by someone from the influencer list. | Engaged with influencers in my space on LinkedIn (account monitoring) |
Older signals only
These values are still returned and accepted as a filter, but no signal template produces them today. They come from signals created before signal templates.
| Value | What happened |
|---|---|
hubspot_contact_detection | A contact was detected from the client's HubSpot. |
salesforce_contact_detection | A contact was detected from the client's Salesforce. |
job_posting | A job posting at a company was found. |
job_posting_insight | An insight was drawn from a company's job postings. |
job_posting_hiring_manager | The likely hiring manager of a job posting was found. |
customer_inbound_comment | Someone from a customer list commented on a post by a person at one of the client's accounts. |
customer_outbound_comment | A person at one of the client's accounts commented on a post by someone from a customer list. |
champion_inbound_comment | A champion commented on a post by a person at one of the client's accounts. |
champion_outbound_comment | A person at one of the client's accounts commented on a post by a champion. |