Start a pitch report

POST

/pitches

Scan a company that isn’t a client yet. Reads their website, works out what they sell and to whom, and runs one scan; the report is ready a few minutes later from the pitch endpoint. Spends one of the month’s pitch reports — 402 when the plan has none left. The prospect is never billed as a client.

Authorizations

• apiKey

Parameters

Query Parameters

brand_id

integer

The brand to read, from GET /brands. Required when the account has more than one brand.

url

required

string

The prospect’s website, e.g. acme.com.

market_code

string

Where to ask the engines from, e.g. GB-en or GB. Default: whatever their site reads as.

Responses

200

OK

object

data

required

object

meta

required

object

api_version

string

Example

v1

brand

object

id

integer

name

string

market

object

id

integer

code

string

label

string

400

Invalid parameter, or brand_id missing on a multi-brand account (brand_required).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

401

Missing, revoked or unknown API key (invalid_api_key).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

403

The plan doesn’t include this data (feature_not_in_plan) or the plan isn’t active (plan_inactive).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

404

The brand or the requested item doesn’t exist (brand_not_found, not_found).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

409

The integration this needs isn’t connected (integration_not_connected).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

429

Monthly read limit reached (quota_exceeded) or more than 60 requests a minute (rate_limited).

object

error

required

object

code

required

string

Example

brand_required

message

required

string

502

An upstream service failed; retry later (upstream_error).

object

error

required

object

code

required

string

Example

brand_required

message

required

string