Getting started

The purpose of this page is to guide you in the Botify API capabilities.

Get API access

To use the API, you need an active user account with the API feature enabled. To do so, either contact your account manager or start a free trial.

Get your token

Once the API is enabled, you can get your token in your profile settings.

List my projects and analyses

Get data about my analyses

In the Botify API, you use BQL (Botify Query Language) to perform operations on analyzed URLs.
This language allow you define fields you want to compute metrics on, group on, filter on, or select. List of fields is available in Analysis Datamodel.

Note that exporting all your URLs is only recommended if you want to cross Botify data to others sources (by matching URL to URL data sources). Indeed using URL aggregation to compute metrics or URL searching is way faster. Plus, according to your plan, csv export can be limited in volume, leading to imcomplete results.

Demo

You can find a demo of the API there.
Note that this demo is using the Javascript SDK which offers an easier way of using the API.

Further reading