Getting started
The purpose of this page is to guide you in the Botify API capabilities.
- Get API access
- Get your token
- List my projects and analyses
- Get data about my analyses
- Further reading
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
- List your projects: getUserProjects
- List your project’s analyses: getProjectAnalyses
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.
- Get some metrics (ex: number of visits, links) for an analysis: getUrlsAggs
- Get the evolution of metrics on your last analyses: getProjectUrlsAggs
- Find some URLs matching a filter: getUrls
- Get information on an URL: getUrlDetails
- Export all my URLs: createUrlsExport
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.