TOtopo
signals

List Signal Presets

Changed on

List the presets a signal can be created from.

Each preset names the detection filters POST /v1/signals accepts and which of them are mandatory. Presets not yet available for creation are omitted.

Requires the signals:read scope on the API key.

get/v1/signals/presets

Request

Response

Successful Response

signal_type'LINKEDIN_OWN_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_POST_ENGAGEMENT' | 'LINKEDIN_PERSON_POST_ENGAGEMENT' | 'LINKEDIN_KEYWORD_MENTION' | 'LINKEDIN_OWN_COMPANY_FOLLOWERS' | 'LINKEDIN_COMPETITOR_FOLLOWERS' | 'LINKEDIN_COMPANY_PAGE_FOLLOWERS' | 'HIRING_SIGNALS' | 'JOB_DESCRIPTION_KEYWORD' | 'FUNDING_EVENTS' | 'TECH_ADOPTION' | 'NEWS_EVENTS' | 'NEW_JOB' | 'CUSTOM_EVENT' | 'LINKEDIN_PARTNER_FOLLOWERS' | 'LINKEDIN_CUSTOMER_FOLLOWERS' | 'LINKEDIN_PARTNER_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_POST_ENGAGEMENT' | 'LINKEDIN_COMPANY_PAGE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_PROFILE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_PARTNER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_OWN_BRAND_MENTION' | 'LINKEDIN_COMPETITOR_MENTION' | 'LINKEDIN_PARTNER_MENTION' | 'LINKEDIN_CUSTOMER_MENTION' | 'LINKEDIN_EVENT_MENTION' | 'COMPETITOR_TECH_ADOPTION' | 'INTEGRATION_TECH_ADOPTION' | 'LINKEDIN_EVENT_PAGE_FOLLOWERS' | 'CHAMPION_CHANGED_JOB' | 'CRM_LIST_ENTRY' required
titlestring required

Display name of the preset.

descriptionstring required

What the preset detects.

category_labelstring required

Catalog category the preset belongs to.

scope'PEOPLE' | 'COMPANY' required
scope_selectable_at_creationboolean required

Whether import_target may pick either entity, instead of being fixed by the scope.

filter_keysFilterFieldKey[] required

Every detection filter the preset accepts.

required_filter_keysFilterFieldKey[] required

The detection filters the preset refuses to go without.

requires_event_subjectboolean required

Whether creation must declare event_subject, which only a custom-event preset does.

preview_supportedboolean required

Whether POST /v1/signals/preview can sample the preset before a signal is created.

backfill_windows_daysinteger[] nullable required

Null when the preset cannot import past matches at creation. Otherwise the windows backfill.window_days must pick from — empty when it takes no window.

Changes

  • 4c947c3f2e11Revision changes
    • info

      added the required property / to the response with the status

  • 451748979321Revision changes
    • warning

      added the new linkedin_watched_engagement enum value to the // response property for the response status

    • warning

      added the new linkedin_watched_engagement enum value to the // response property for the response status