Other
Warmup companies
Check available companies in Ocean's database and trigger process of data gathering for the missing ones.
Calling this endpoint does not consume any credits
Query Parameters
apiToken?|
Header Parameters
x-api-token?|
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
curl -X POST "https://api.ocean.io/v2/warmup/companies" \ -H "Content-Type: application/json" \ -d '{ "domains": [ "ocean.io", "denmark.dk" ] }'{
"successfulDomains": [
"successful-domain-1.com",
"successful-domain-2.com"
],
"triggeredDomains": [
"domain-to-be-crawled-1.com",
"domain-to-be-crawled-2.com"
],
"ignoredDomains": [
"bad-domain-1",
"bad-domain-2"
],
"missingDomains": {
"missing-domain-1.com": "bad content",
"missing-domain-2.com": "crawler failed"
},
"dataErrors": {
"data-errors-domain-1.com": "missing context vector",
"data-errors-domain-2.com": "missing industry features"
}
}{
"detail": "Conflicting API tokens provided in query parameters and headers"
}{
"detail": "Insufficient email credits"
}{
"detail": "API token should be provided in headers or query parameters"
}Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}