Warmup companies

POST /v2/warmup/companies

Check available companies in Ocean's database and trigger process of data gathering for the missing ones

application/json

Body Required

  • domains array[string] Required

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

    At least 1 but not more than 500 elements.

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • successfulDomains array[string] | null
    • triggeredDomains array[string] | null
    • ignoredDomains array[string] | null
    • missingDomains object | null
      Hide missingDomains attribute Show missingDomains attribute object | null
      • * string Additional properties

        Values are bad content, crawler failed, data gathering started, in progress, invalid domain, other error, robots disallowed, unsupported language, or invalid redirect.

    • dataErrors object | null
      Hide dataErrors attribute Show dataErrors attribute object | null
      • * string Additional properties

        Values are missing context vector, missing industries, missing keywords, or missing industry categories.
  • 403 application/json

    Forbidden

    Hide response attribute Show response attribute object
    • detail string Required

      Value is Current API token is not registered in our database.
  • 402 application/json

    Payment Required

    Hide response attribute Show response attribute object
    • detail string Required

      Values are Insufficient email credits, Some email verifications are already in progress and might use all your remaining email credits. Please try again later., Insufficient phone credits, or Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later..
  • 404

    Not found

  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
POST /v2/warmup/companies 
curl \
 -X POST https://api.ocean.io/v2/warmup/companies?apiToken=string \
 -H "Content-Type: application/json" \
 -d '{"domains":["ocean.io","denmark.dk"]}'
Request examples 
{
  "domains": [
    "ocean.io",
    "denmark.dk"
  ]
}
Response examples (200) 
{
  "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"
  }
}
Response examples (403) 
{
  "detail": "Current API token is not registered in our database"
}
Response examples (402) 
{
  "detail": "Insufficient email credits"
}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}