Monitor
/
Get incident prediction

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

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": [
    { … },
    { … },
    { … }
  ]
}

Get incident prediction

Request

Get incident 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-incident-prediction?period=6' \
  -H 'apikey: YOUR_API_KEY_HERE'

Responses

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

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

Get subdomain findings

Request

Subdomain findings list

Query
subdomainstringrequired

subdomain of company

Example: subdomain=google.com
risk_vector_typestringrequired

risk vector type

Example: risk_vector_type=DKIM
pageinteger

Page number

Example: page=1
curl -i -X GET \
  'https://apidocs.rankiteo.com/_mock/openapi/monitor-get-subdomain-findings?page=1&risk_vector_type=DKIM&subdomain=google.com' \
  -H 'apikey: YOUR_API_KEY_HERE'

Responses

Successful response containing subdomain findings and pagination.

Bodyapplication/json
dataobject
paginationobject
messageobject
Example: {"data":{"subdomain_name":"rankiteo.com","message":"No DKIM findings for this domain"}}
Response
application/json
{
  "data": {
    "domain_name": "rankiteo.com",
    "subdomain": [ … ]
  },
  "pagination": {
    "current_page": 1,
    "page_size": 10,
    "total_pages": 5,
    "total_items": 47
  }
}

Underwriter

Operations

Vulnerability

Operations