Skip to main content
POST

Authorizations

x-api-key
string
header
required

Body

application/json
radar_type
enum<string>
required

The type of industry activity to track

Available options:
industry_mentions,
industry_funding_rounds,
industry_new_companies,
industry_job_openings
webhook_url
string<uri>

Webhook URL to receive radar updates and notifications. Optional — if omitted, the radar is poll-only and updates are available via GET /v1/updates.

Example:

"https://webhook.site/your-webhook-id"

updates_since
string<date-time>

Optional RFC 3339 timestamp with a UTC offset defining the earliest eligible source event. TAMradar normalizes and stores the value in UTC. It must represent now or a past instant and may be at most five calendar years old. A five-second server tolerance exists only for clock skew; it is not future scheduling. When omitted, the radar creation timestamp is used as the effective cutoff.

include_historical
boolean
deprecated

Deprecated compatibility field. It is accepted and stored but has no effect. Use updates_since to request historical eligibility.

keyword
string

Required for 'industry_mentions' and 'industry_job_openings'. The keyword or phrase to track across all domains or in job postings. Must be at least 3 characters long. Not used for 'industry_funding_rounds' or 'industry_new_companies'.

Minimum string length: 3
Example:

"artificial intelligence"

countries
string[]

Optional for 'industry_job_openings' only. Array of country names to filter job postings by location. Maximum 5 countries allowed. Examples: 'United States', 'Canada', 'United Kingdom'.

Maximum array length: 5
Example:
custom_fields
object

Optional metadata to attach to this radar. Values must be strings only. Use for internal tracking like account_id, customer_id, or campaign_id. Returned with every webhook.

Example:

Response

Radar created successfully

status
enum<string>
Available options:
success
code
enum<integer>
Available options:
201
message
string
data
object
timestamp
string<date-time>