Skip to main content
POST
/
api
/
v1
/
signal
/
deploy
/
social-listening-agent
Deploy Social Listening Signal
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/signal/deploy/social-listening-agent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "name": "<string>",
  "search_query": "<string>",
  "timeframe": 90,
  "signal_target": "account",
  "icp_id": 123,
  "repeat": false,
  "account_audience_name": "<string>",
  "people_audience_name": "<string>",
  "max_credit_limit": 123
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

X-API-Key
string
required
X-User-ID
string
required

Body

application/json
name
string
required

Name/identifier for this signal run

search_query
string
required

LinkedIn search keyword (e.g. 'AI tools')

timeframe
integer
required

Time limit in days (1-180)

Required range: 1 <= x <= 180
signal_target
enum<string>
default:account

Whether to discover accounts or people

Available options:
account,
people
icp_id
integer | null

ICP ID to use for filtering

repeat
boolean | null
default:false

Whether this signal should recur daily

account_audience_name
string | null

Audience name for auto-adding discovered accounts

people_audience_name
string | null

Audience name for people enrichment

max_credit_limit
integer | null

Credit limit to enforce on this signal. Signal will stop once max_credit_limit is hit

Response

Successful Response