Web Scraping
Keywords we look for on websites — what your buyers write, or a competitor's script — and every match becomes a lead.
Read your Web Scraping keywords and their results, change them, or ask for keyword ideas from your own code. Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| GET | /v3/web-scraping | Get Web Scraping keywords |
| PUT | /v3/web-scraping | Update Web Scraping keywords |
| POST | /v3/web-scraping/keyword-suggestions | Suggest Web Scraping keywords |
/v3/web-scrapingcurl -X GET "https://rest-dash.revealid.xyz/v3/web-scraping?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9"What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| websiteId* | string | — | any |
Use case: Watch a competitor
PUT /v3/web-scraping with enabled: true and a keyword like { "value": "competitor-tool.com", "matchMode": "exact" }. Send the whole list: it replaces the keywords, so GET /v3/web-scraping first and add to what it returns. dailyLimit is 1 to 500 leads a day (1 credit each); contactsOnly: true adds only companies where a person was found.
Use case: Which keywords work
GET /v3/web-scraping returns leads per keyword over the last 7 days; pause the silent ones with "paused": true on that keyword in the next PUT.
Use case: Keyword ideas
POST /v3/web-scraping/keyword-suggestions returns phrases your buyers would write about themselves; regenerate: true asks for new ones. Nothing is saved until you PUT them.