CrawlingApi.md

CrawlingApi

All URIs are relative to https://api.rankvectors.com

Method	HTTP request	Description
getCrawlHistory	GET /api/projects/{projectId}/crawl	Get crawl history
startCrawl	POST /api/projects/{projectId}/crawl	Start website crawl

getCrawlHistory

List<Crawl> getCrawlHistory(projectId)

Get crawl history

Get the crawl history for a project

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.CrawlingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rankvectors.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    CrawlingApi apiInstance = new CrawlingApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    try {
      List<Crawl> result = apiInstance.getCrawlHistory(projectId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CrawlingApi#getCrawlHistory");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
projectId	String	Unique identifier for the project

Return type

List<Crawl>

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Crawl history	-
401	Unauthorized - missing or invalid API key	-
403	Forbidden - access denied to resource	-
404	Not found - resource doesn't exist	-
500	Internal server error	-

startCrawl

Crawl startCrawl(projectId, startCrawlRequest)

Start website crawl

Start crawling a website to analyze content for link opportunities

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.CrawlingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rankvectors.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    CrawlingApi apiInstance = new CrawlingApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    StartCrawlRequest startCrawlRequest = new StartCrawlRequest(); // StartCrawlRequest | 
    try {
      Crawl result = apiInstance.startCrawl(projectId, startCrawlRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CrawlingApi#startCrawl");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
projectId	String	Unique identifier for the project
startCrawlRequest	StartCrawlRequest		[optional]

Return type

Crawl

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Crawl started successfully	-
401	Unauthorized - missing or invalid API key	-
403	Forbidden - access denied to resource	-
404	Not found - resource doesn't exist	-
500	Internal server error	-