Botify

Botify API

Botify Saas API

Data & analytics#openapi#analytics#tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Botify Saas API

Endpoints 26

Project

  • GETList all analyses for a project/analyses/:username/:project_slug?page=0&size=0List all analyses for a project
  • POSTMatch and replace parts of a URL based on rules passed in POST data/projects/:username/:project_slug/features/url_rewriting/rules_validatorMatch and replace parts of a URL based on rules passed in POST data.
  • GETList all the project's saved filters (each filter's name, ID and filter value)/projects/:username/:project_slug/filters?page=0&size=0List all the project's saved filters (each filter's name, ID and filter value)
  • GETRetrieves a specific saved filter's name, ID and filter value/projects/:username/:project_slug/filters/:identifierRetrieves a specific saved filter's name, ID and filter value
  • POSTProject Query aggregator/projects/:username/:project_slug/urls/aggs?area=current&last_analysis_slug=string&nb_analyses=20Project Query aggregator. It accepts multiple queries that will be executed on all completed analyses in the project

Analysis

  • GETGet an Analysis detail/analyses/:username/:project_slug/:analysis_slugGet an Analysis detail
  • GETReturn global statistics for an analysis/analyses/:username/:project_slug/:analysis_slug/crawl_statisticsReturn global statistics for an analysis
  • GETReturn crawl statistics grouped by time frequency (1 min, 5 mins or 60 min)/analyses/:username/:project_slug/:analysis_slug/crawl_statistics/time?limit=0&frequency=1mnReturn crawl statistics grouped by time frequency (1 min, 5 mins or 60 min) for an analysis
  • GETReturn a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)/analyses/:username/:project_slug/:analysis_slug/crawl_statistics/urls/:list_typeReturn a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)
  • GETList of Orphan URLs/analyses/:username/:project_slug/:analysis_slug/features/ganalytics/orphan_urls/:medium/:source?page=0&size=0List of Orphan URLs. URLs which generated visits from the selected source according to Google Analytics data, but were not crawled with by the Botify crawler…
  • GETGet inlinks percentiles/analyses/:username/:project_slug/:analysis_slug/features/links/percentilesGet inlinks percentiles
  • GETLost pagerank/analyses/:username/:project_slug/:analysis_slug/features/pagerank/lostLost pagerank
  • GETGet global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc/analyses/:username/:project_slug/:analysis_slug/features/sitemaps/reportGet global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc.)
  • GETSample list of URLs which were found in your sitemaps but outside of the/analyses/:username/:project_slug/:analysis_slug/features/sitemaps/samples/out_of_config?page=0&size=0Sample list of URLs which were found in your sitemaps but outside of the crawl perimeter defined for the project, for instance domain/subdomain or protocol…
  • GETSample list of URLs which were found in your sitemaps, within the project/analyses/:username/:project_slug/:analysis_slug/features/sitemaps/samples/sitemap_only?page=0&size=0Sample list of URLs which were found in your sitemaps, within the project allowed scope (allowed domains/subdomains/protocols), but not found by the Botify…
  • GETTop domains/analyses/:username/:project_slug/:analysis_slug/features/top_domains/domains?page=0&size=0Top domains
  • GETTop subddomains/analyses/:username/:project_slug/:analysis_slug/features/top_domains/subdomains?page=0&size=0Top subddomains
  • POSTExecutes a query and returns a paginated response/analyses/:username/:project_slug/:analysis_slug/urls?area=current&page=0&size=0Executes a query and returns a paginated response
  • POSTQuery aggregator/analyses/:username/:project_slug/:analysis_slug/urls/aggs?area=currentQuery aggregator. It accepts multiple queries
  • GETGets an Analysis datamodel/analyses/:username/:project_slug/:analysis_slug/urls/datamodel?area=currentGets an Analysis datamodel
  • GETA list of the CSV Exports requests and their current status/analyses/:username/:project_slug/:analysis_slug/urls/export?page=0&size=0A list of the CSV Exports requests and their current status
  • POSTCreates a new UrlExport object and starts a task that will export the results into a csv/analyses/:username/:project_slug/:analysis_slug/urls/export?area=currentCreates a new UrlExport object and starts a task that will export the results into a csv. Returns the model id that manages the task
  • GETChecks the status of an CSVUrlExportJob object/analyses/:username/:project_slug/:analysis_slug/urls/export/:url_export_idChecks the status of an CSVUrlExportJob object. Returns json object with the status.
  • POSTReturn most frequent segments (= suggested patterns in the previous version)/analyses/:username/:project_slug/:analysis_slug/urls/suggested_filters?area=currentReturn most frequent segments (= suggested patterns in the previous version) for a Botify Query.
  • GETGets the detail of an URL for an analysis/analyses/:username/:project_slug/:analysis_slug/urls/:url?fields=stringGets the detail of an URL for an analysis

User

  • GETList all active projects for the user/projects/:username?page=0&size=0List all active projects for the user

API details

Base URL
https://api.botify.com/v1
Authentication
An API key in the Authorization header
Operations
26 operations on 25 pathsGET 20POST 6
Main resources
Analysis 20Project 5User 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Botify API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Botify API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List all analyses for a project” (GET /analyses/:username/:project_slug?page=0&size=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Botify API?

Botify Saas API It is listed under Data & analytics and has 26 endpoints.

Who publishes the Botify API?

It is listed from Botify's public API description (an OpenAPI document), not published by Botify on Swastik Codes. Anyone who controls botify.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Botify API?

Requests go to https://api.botify.com/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Botify API?

With an API key in the Authorization header.

How many endpoints does the Botify API have?

26 operations on 25 paths (20 GET, 6 POST). The largest groups are Analysis, Project, User.

Is forking the Botify API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.