Create a radar and start its first sweep
As Create radar in the app does, in a folder of the account (folder_id) or a new one made with it (folder_name): one of the two is required, and a folder_name the account already has fails with conflict. A news radar's first sweep covers the last seven days; without sources, it reads the open web, and the custom sources it names. With type tenders, a tender radar: its countries and words; its first sweep looks at the last year and keeps the calls still open. With type rates, an exchange and interest rate radar: its pairs, its interest_rates, or both; it is never swept, so its sweep is null, and its rates are at /radars/{id}/rates. With type commodity_prices, a price radar: its commodities; likewise never swept, and its prices are at /radars/{id}/prices.
A key created in the app under Settings, API and MCP. Read keys read; Read and write keys also add, edit and delete companies, custom sources, groups and radars, and create, rename and delete folders.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/radars" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "query": { "lines": [ { "joiner": "AND", "chips": [ { "filter": "string" } ] } ] } }'{ "radar": { "id": 1, "name": "string", "type": "news", "folder": { "id": 1, "name": "string" }, "query": { "lines": [ { "joiner": "AND", "chips": [ { "kind": "event", "id": 1, "key": "string", "label": "string", "member_ids": [ 1 ] } ] } ] }, "query_text": "string", "sources": [ "linkedin" ], "custom_source_ids": [ 1 ], "source_group_ids": [ 1 ], "languages": [ "en" ], "cadence": "weekly", "window_days": -9007199254740991, "searchable": true, "sweeping": true, "last_sweep_at": "2019-08-24T14:15:22Z", "next_sweep_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" }, "sweep": { "id": 1, "radar_id": 1, "started_by": "created", "status": "queued", "window": { "start": "2019-08-24", "end": "2019-08-24" }, "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "counts": { "articles": -9007199254740991, "judged": -9007199254740991, "kept": -9007199254740991, "new_signals": -9007199254740991, "sources_added": -9007199254740991, "new_calls": -9007199254740991 } }, "message": "string"}