With the Warmup API Endpoint, you can ensure in advance that all domains you will input in other API calls will be crawled already by Ocean.
Use case
An example use case is for companies who want to enrich their dataset. To ensure that Ocean has information on all companies that are added to your CRM, you can provide Ocean with a list of domains prior to using the Enrich API endpoints. That way, Ocean will ensure all domains that it has not yet crawled in the past, will get crawled.
Step-by-step guide
Here's a step-by-step guide to make an API call to the Warmup API Endpoint, using Postman.
Click on + in your workspace to add a new call.
Ensure the request type is set to POST
Copy and paste the link below into the Enter URL or paste text field, where you replace XXX with your API token (need help to find your API token?)
Ensure you add Content-Type: application/json in your Headers.
In the Body, parse a list of domains that you want Ocean to crawl if it hasn't been crawled already. Minimum 1, maximum 1,000. Below is an example:
{
"domains": [
"ocean.io",
"denmark.dk"
]
}
Ensure you choose JSON in the Body, before hitting Send and make your call.
That's it! Now you get a message in return that states which domains have already been crawled in the past (successfulDomains), for which it triggered the crawling (triggeredDomains) and for which domains it was not possible to trigger the crawling (ignoredDomains).
💸 Credit usage: Calling this endpoint is free. Note that it does not yet return the information on a company; for that, you need to use the Enrich endpoint afterwards.