How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Botify

Botify Analysis API

The Analysis API from Botify — 30 operation(s) for analysis.

Documentation Provider Profile APIs.io OpenAPI GitHub

Botify Analysis API is one of 9 APIs that Botify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analysis. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 31 operations across 30 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.botify.com/v1.

31 operations 30 paths 44 schemas 25 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.botify.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Botify Analysis API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (DjangoRestToken). By default, every request must be authenticated.

Paths & Operations 31

Across 30 paths, the API surfaces 31 operations — 25 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Analysis 31
POST
/analyses/{username}/{project_slug}/create/launch
Create and launch an analysis for a project
launchAnalysisCreate 2 params → default201
GET
/analyses/{username}/{project_slug}/{analysis_slug}
Get an Analysis detail
getAnalysisSummary 4 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics
Return global statistics for an analysis
getCrawlStatistics 3 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/time
Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min) for an analysis
getCrawlStatisticsByFrequency 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/urls/{list_type}
Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)
getCrawlStatisticsUrls 4 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/ganalytics/orphan_urls/{medium}/{source}
Legacy
getGanalyticsOrphanURLs 7 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/links/percentiles
Get inlinks percentiles
getLinksPercentiles 3 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/pagerank/lost
Lost pagerank
getPageRankLost 3 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/scoring/summary
Scoring summary
getScoring 3 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/search_console/stats
List clicks and impressions per day
getKeywordsStats 3 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/report
Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc.)
getSitemapsReport 3 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/out_of_config
Sample 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 (HTTP/HTTPS) not allowed in the crawl setti…
getSitemapsSamplesOutOfConfig 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/sitemap_only
Sample list of URLs which were found in your sitemaps, within the project allowed scope (allowed domains/subdomains/protocols), but not found by the Botify crawler.
getSitemapsSamplesSitemapsOnly 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/domains
Top domains
getLinksTopDomains 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/subdomains
Top subddomains
getLinksTopSubdomains 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/features/visits/orphan_urls/{medium}/{source}
List 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 (either because no links to them were fou…
getVisitsOrphanURLs 7 params → default200
POST
/analyses/{username}/{project_slug}/{analysis_slug}/pause
Pause an analysis for a project
pauseAnalysis 3 params → default201
POST
/analyses/{username}/{project_slug}/{analysis_slug}/resume
Resume an analysis for a project
resumeAnalysis 3 params → default201
GET
/analyses/{username}/{project_slug}/{analysis_slug}/segments
Get the segments feature public metadata of an analysis.
getAnalysisSegments 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/staticfiles/robots-txt-indexes
Return an object containing all robots.txt files found on the project's domains. The object is null for virtual robots.txt.
getRobotsTxtIndexesView 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/staticfiles/robots-txt-indexes/{robots_txt}
Return content of a robots.txt file.
getRobotsTxtFileView 6 params → default200
POST
/analyses/{username}/{project_slug}/{analysis_slug}/urls
Executes a query and returns a paginated response
getUrls 7 params body → default200
POST
/analyses/{username}/{project_slug}/{analysis_slug}/urls/aggs
Query aggregator. It accepts multiple queries and dispatches them.
getUrlsAggs 5 params body → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/urls/ai/{url}
Gets AI suggestions of an URL for an analysis
getUrlAI 4 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel
Gets an Analysis datamodel
getUrlsDatamodel 5 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/urls/datasets
Gets Analysis Datasets
getUrlsDatasets 7 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/urls/export
A list of the CSV Exports requests and their current status
getUrlsExports 5 params → default200
POST
/analyses/{username}/{project_slug}/{analysis_slug}/urls/export
Creates a new UrlExport object and starts a task that will export the results into a csv. Returns the model id that manages the task
createUrlsExport 8 params body → default201
GET
/analyses/{username}/{project_slug}/{analysis_slug}/urls/export/{url_export_id}
Checks the status of an CSVUrlExportJob object. Returns json object with the status.
getUrlsExportStatus 4 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/urls/html/{url}
Gets the HTML of an URL for an analysis
getUrlHTML 4 params → default200
GET
/analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}
Gets the detail of an URL for an analysis
getUrlDetail 5 params → default200

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are AnalysisDetail (28 properties), CrawlStatisticsTime (16 properties), DatasetField (14 properties), CrawlStatistics (11 properties). Each schema is shown below with its type and property counts.

CsvExportStatus
object
10 properties 2 required
KeywordsStats
object
1 property 1 required
SuggestedOperations
object
4 properties 3 required
DatamodelGroup
object
2 properties 2 required
Datasets
object
1 property 1 required
AnalysisSegments
object
Analysis Segments
1 property
DatamodelField
object
10 properties 8 required
UrlDetail
object
DefaultPayload
object
default payload for object for all HTTP codes that are not covered individually
1 property
CrawlStatistics
object
11 properties 10 required
Dataset
object
7 properties 5 required
Default
object
ScoringSummary
object
1 property 1 required
DatasetField
object
14 properties 8 required
Datamodel
object
4 properties 2 required
CrawlOrphanURLs
object
2 properties
KeywordsStat
object
3 properties 2 required
Aggs
object
2 properties 1 required
LinksTopDomains
object
7 properties 7 required
CrawlStatisticsTimePoint
object
2 properties 2 required
CrawlStatisticsUrls
object
9 properties 8 required
AnalysisResume
object
Resume Analysis
CrawlStatisticsTime
object
16 properties 10 required
SitemapsReportOnly
object
2 properties
LinksTopDomainsSamples
object
3 properties 3 required
KeywordsStatDetail
object
4 properties 4 required
LinksPercentilesItem
object
6 properties 6 required
SitemapsReportSitemapError
object
2 properties
AnalysisPause
object
Pause Analysis
UrlAI
object
1 property 1 required
AggsQuery
object
AggsQuery
2 properties
ErrorAgg
object
2 properties 2 required
User
object
5 properties 1 required
SitemapsReport
object
5 properties
LinksPercentiles
object
2 properties 2 required
SitemapsReportSitemap
object
7 properties
Query
object
Query
3 properties
PageRankLost
object
3 properties 3 required
AnalysisDetail
object
28 properties 1 required
DatasetGroup
object
8 properties 2 required
KeywordsStatData
object
5 properties 5 required
AnalysisCreateAndLaunch
object
Create and Launch Analysis
UrlHTML
object
AggsQueries
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

botify-analysis-api-openapi.yml Raw ↑

Other APIs Botify publishes across the network.

Botify Agents MCP
AE Profile APIs.io
Botify Collections API
AE Profile APIs.io
Botify Datasource API
AE Profile APIs.io
Botify Job API
AE Profile APIs.io
Botify Keywords Groups API
AE Profile APIs.io
Botify Project API
AE Profile APIs.io
Botify Project Query API
AE Profile APIs.io
Botify User API
AE Profile APIs.io
#Analysis
← Back to B APIs
API Details
ID
botify:botify-analysis-api
Base URL
https://api.botify.com/v1
Docs
https://developers.botify.com/
Provider
Botify
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=botify-analysis-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/botify-analysis-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Botify Analysis API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.