Sign in

v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB
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

post/v2/warmup/companies

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

domainsstring[] required

Domains to be checked and added to the database if not present

Example request

{
  "domains": [
    "ocean.io",
    "denmark.dk"
  ]
}

Response

Successful Response

successfulDomainsstring[] nullable

Domains that are already present in Ocean's database

triggeredDomainsstring[] nullable

Domains that are not currently present in Ocean's database. Data gathering process has been triggered for them

ignoredDomainsstring[] nullable

Invalid domains that failed validation process

missingDomainsobject nullable

Domains that are not present in Ocean's database and the reason

dataErrorsobject nullable

Domains that are present in Ocean's database but lack the necessary data to perform the search, along with the reason

Example response

{
  "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"
  }
}