Botify API

Tools (28)

Extracted live via the executor SDK.

• analysis.createUrlsExport

  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

• analysis.getAnalysisSummary

  Get an Analysis detail

• analysis.getCrawlStatistics

  Return global statistics for an analysis

• analysis.getCrawlStatisticsByFrequency

  Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min) for an analysis

• analysis.getCrawlStatisticsUrls

  Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)

• analysis.getGanalyticsOrphanUrLs

  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 found on the website, or because the crawler was not allowed to follow these links according to the project settings). For a search engine (medium: origanic; sources: all, aol, ask, baidu, bing, google, naver, yahoo, yandex) or a social network (medium: social; sources: all, facebook, google+, linkedin, pinterest, reddit, tumblr, twitter)

• analysis.getLinksPercentiles

  Get inlinks percentiles

• analysis.getLinksTopDomains

  Top domains

• analysis.getLinksTopSubdomains

  Top subddomains

• analysis.getPageRankLost

  Lost pagerank

• analysis.getSitemapsReport

  Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc.)

• analysis.getSitemapsSamplesOutOfConfig

  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 settings.

• analysis.getSitemapsSamplesSitemapsOnly

  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.

• analysis.getUrlDetail

  Gets the detail of an URL for an analysis

• analysis.getUrls

  Executes a query and returns a paginated response

• analysis.getUrlsAggs

  Query aggregator. It accepts multiple queries

• analysis.getUrlsDatamodel

  Gets an Analysis datamodel

• analysis.getUrlsExports

  A list of the CSV Exports requests and their current status

• analysis.getUrlsExportStatus

  Checks the status of an CSVUrlExportJob object. Returns json object with the status.

• analysis.getUrlsSuggestedFilters

  Return most frequent segments (= suggested patterns in the previous version) for a Botify Query.

• project.getProjectAnalyses

  List all analyses for a project

• project.getProjectUrlsAggs

  Project Query aggregator. It accepts multiple queries that will be executed on all completed analyses in the project

• project.getSavedFilter

  Retrieves a specific saved filter's name, ID and filter value

• project.getSavedFilters

  List all the project's saved filters (each filter's name, ID and filter value)

• project.testUrlRewritingRules

  Match and replace parts of a URL based on rules passed in POST data.

• user.getUserProjects

  List all active projects for the user

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools