Skip to main content
POST
Derive a listener plan from a website

Authorizations

Authorization
string
header
required

A workspace API key, created in workspace settings and sent as Authorization: Bearer op_live_…. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.

Body

application/json

The wizard's step-1 answers. sources and objective decide the mode: find_local_prospects plans a places listener, find_dissatisfaction plans a rivals listener, and every other objective plans market.

companyName
string
required

The company's name.

Required string length: 2 - 120
website
string<uri>
required

The company's homepage. This is what gets crawled.

objective
enum<string>
required

What the listener is for. find_dissatisfaction returns a rival profile (competitor names, pain vocabulary); find_local_prospects returns a places profile (categories, locations); every other value, including custom, returns a market keyword plan.

Available options:
find_customers,
find_competitors,
find_partnerships,
find_dissatisfaction,
find_local_prospects,
custom
sources
enum<string>[]
required

Which platforms the resulting plan should carry queries for.

Minimum array length: 1
Available options:
x,
linkedin,
facebook,
reddit,
hackernews,
linkedin_jobs,
indeed,
ashby,
greenhouse,
lever,
google_reviews,
g2,
trustpilot,
youtube
customObjective
string

Free text describing the objective when objective is custom.

Maximum string length: 500
description
string

A short description of the business, used to plan when the site cannot be crawled. Required on the retry that follows a website_unreadable 422.

Maximum string length: 2000
acceptLimited
boolean
default:false

Set on a retry to proceed without a successful crawl, planning from description instead. Sending it true on the first call skips the crawl for no reason, since there is no description yet to plan from.

Response

Success.

The response is of type object.