Skip to main content

Getting Started with the Oncrawl API

Oncrawl is based on a platform built around an API. Create your own application to request this API very easily. Here's how to do it.

The Oncrawl API can be used via two different methods:

  1. Using an API token generated by the user account.

  2. Using an OAuth application to connect to Oncrawl using the user's account.

Both methods access the same API and have the same rights and restrictions.

Using an API token

You will need to have a subscription that includes the Oncrawl API option.

From your workspace settings page, scroll down to the "API Access Tokens" section. Click on "View API Access Tokens" to see the list of tokens you have generated.

For each token, the list provides:

  • The token's description

  • The token's permissions:
    ​- account read: the application can display the user, its subscription, its quotas
    - account write: you can use the token to modify certain user properties
    - project read: you can use the token to list the user's projects / crawls
    - project write: you can use the token to create projects / start / remove crawls

  • The date the token was last used

  • The button "Delete" to permanently delete the token

You can create a new token by clicking on "Add API Token" at the bottom of the list and supplying the following information:

  • Token description: this name will help you identify the token later from the list of existing tokens

  • The token permissions:
    ​- account read: using the token, you can can display the user, its subscription, its quotas
    - account write: using the token, you can modify certain user properties
    - project read: using the token, you can list the user's projects / crawls
    - project write: using the token, you can create projects / start / remove crawls

Read the doc

The API documentation can be found at this address https://developer.oncrawl.com/.

Here you will find the essential information you need to start up your application.

We have taken care to detail key steps to follow in the implementation of your applications, use cases and details about each exchange parameters between your application and the API.
​
It provides both a reference documentation, a set of guides and code examples that will help you get started with Oncrawl API.

What is the OQL (Oncrawl Query Language)?

All API requests are expressed in our OQL.

This is an overlay of ElasticSearch for reporting / queries / live aggregations.

Contact : developer-support@oncrawl.com for API support

What metrics are in the API?

All Oncrawl metrics that are available in the Data Explorer interface are also accessible via the API: this includes crawl data, log file data, and cross-analysis data.

The Oncrawl API can also be used to create and modify crawl profiles, run and schedule crawls, and carry out other actions on your account to automate programmatically how you use Oncrawl.

Quick start tip

All Oncrawl charts include the API calls and the response format in the information about them.

Click on the information symbol that appears when you hover over a chart, then navigate to the "API calls" tab.

​

Related Articles
Did this answer your question?