Monitor
/
Add manual subsidiary

Rankiteo API (0.0.1-beta)

The Rankiteo API

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://gitbook.com/support

API Support

support@rankiteo.com

Terms of Service

Languages
Servers
Mock server

https://apidocs.rankiteo.com/_mock/openapi/

production

https://api.rankiteo.com/

General

Operations

Monitor

Operations

Add manual subsidiary

Request

Add manual subsidiary under parent subsidiary

Bodyapplication/jsonrequired
namestringrequired

Name of the subsidiary to be added

Example: "scoring"
websitestringrequired

Website of the subsidiary

Example: "https://appler.co"
employeesstringrequired

Employee number company have

Example: 100
followersstringrequired

Follower number company have

Example: 100
industrystringrequired

Industry type of the parent company. Please refers https://learn.microsoft.com/en-us/linkedin/shared/references/reference-tables/industry-codes-v2

Example: "Cyber security"
sub_industrystringrequired

Industry type of the subsidiary company. Please refers https://learn.microsoft.com/en-us/linkedin/shared/references/reference-tables/industry-codes-v2

Example: "Cyber"
linkedin_idstring

linkedin Id of the company

Example: "Cyber"
parent_company_namestring

Name of the parent company

Example: "Rankiteo"
parent_linkedin_idstring

Linkedin Id of the parent company

Example: "rankiteo"
curl -i -X POST \
  https://apidocs.rankiteo.com/_mock/openapi/monitor-add-subsidiary \
  -H 'Content-Type: application/json' \
  -H 'apikey: YOUR_API_KEY_HERE' \
  -d '{
    "name": "scoring",
    "website": "https://appler.co",
    "employees": 100,
    "followers": 100,
    "industry": "Cyber security",
    "sub_industry": "Cyber",
    "linkedin_id": "Cyber",
    "parent_company_name": "Rankiteo",
    "parent_linkedin_id": "rankiteo"
  }'

Responses

Successful response for add request

Bodyapplication/json
messagestring
Example: "Subsidiary added successfully"
Response
application/json
{
  "message": "Subsidiary added successfully"
}

Delete manual subsidiary

Request

Delete manual subsidiary

Query
subsidiary_idstringrequired

subsidiary id of company

Example: subsidiary_id=YOU_2660260
curl -i -X DELETE \
  'https://apidocs.rankiteo.com/_mock/openapi/monitor-delete-subsidiary?subsidiary_id=YOU_2660260' \
  -H 'apikey: YOUR_API_KEY_HERE'

Responses

Successful response for delete request

Bodyapplication/json
messagestring
Example: "Subsidiary deleted successfully"
Response
application/json
{
  "message": "Subsidiary deleted successfully"
}

Get data loss prediction

Request

Get data loss prediction for 6 months or 12 months for a specific company

Query
periodnumber

Period value is a timeframe. It can be 6 or 12. By default its value is 6

Example: period=6
curl -i -X GET \
  'https://apidocs.rankiteo.com/_mock/openapi/monitor-get-data-loss-prediction?period=6' \
  -H 'apikey: YOUR_API_KEY_HERE'

Responses

Data loss prediction response for three incident types - Cyber Attack, Human/System Error and Physical Attack

Bodyapplication/json
linkedin_idstring

LinkedIn identifier for the company

Example: "google"
periodinteger

Timeframe of prediction

Example: 6
dataArray of objects
messagestring
Example: "No predictions available"
Response
application/json
{
  "linkedin_id": "google",
  "period": 6,
  "data": [
    { … },
    { … },
    { … }
  ]
}

Underwriter

Operations

Vulnerability

Operations