Skip to main content
POST
/
v1
/
radars
/
industry
curl --request POST \ --url https://api.tamradar.com/v1/radars/industry \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "radar_type": "industry_mentions", "webhook_url": "https://webhook.site/your-webhook-id", "keyword": "artificial intelligence", "custom_fields": { "account_id": "acc_123", "market_research": "ai-trends-2024" } } '
{ "status": "success", "code": 201, "timestamp": "2024-03-20T10:15:30.000Z", "message": "Radar created successfully", "data": { "radar_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "radar_type": "industry_mentions", "domain": null, "webhook_url": "https://webhook.site/your-webhook-id", "radar_status": "active", "created_at": "2024-03-20T10:15:30.000Z", "deactivated_at": null, "next_charge_at": "2024-04-20T10:15:30.000Z", "custom_fields": { "account_id": "acc_123", "market_research": "ai-trends-2024" }, "keyword": "artificial intelligence" } }

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"

​
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:
["United States", "Canada"]
​
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:
{
  "account_id": "acc_123",
  "market_research": "ai-trends-2024",
  "priority": "high"
}

Response

Radar created successfully

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