botify
Module botify
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_botify_1.5.0.png)
ballerinax/botify Ballerina library
Overview
This is a generated connector for Botify API v1.0.0 OpenAPI specification.
Botify Saas API comprise data about thousands of relevant SEO metrics, computed through website crawling and server logs ingestion.
Clients![](/images/permalink.svg)
botify: Client![](/images/permalink.svg)
This is a generated connector for Botify API v1.0.0 OpenAPI specification. API for Internet Archive's Search-related services.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Request a Botify Account and obtain tokens following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.botify.com/v1" - URL of the target service
getProjectAnalyses![](/images/permalink.svg)
function getProjectAnalyses(string username, string projectSlug, int? page, int? size) returns InlineResponse200|error
List all analyses for a project
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse200|error - Successful operation
getAnalysisSummary![](/images/permalink.svg)
function getAnalysisSummary(string username, string projectSlug, string analysisSlug) returns AnalysisDetail|error
Get an Analysis detail
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- AnalysisDetail|error - Successful operation
getCrawlStatistics![](/images/permalink.svg)
function getCrawlStatistics(string username, string projectSlug, string analysisSlug) returns CrawlStatistics|error
Return global statistics for an analysis
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- CrawlStatistics|error - Successful operation
getCrawlStatisticsByFrequency![](/images/permalink.svg)
function getCrawlStatisticsByFrequency(string username, string projectSlug, string analysisSlug, string frequency, int? 'limit) returns CrawlStatisticsTime|error
Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min)
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- frequency string - Aggregation frequency
- 'limit int? (default ()) - max number of elements to retrieve
Return Type
- CrawlStatisticsTime|error - Successful operation
getCrawlStatisticsUrls![](/images/permalink.svg)
function getCrawlStatisticsUrls(string username, string projectSlug, string analysisSlug, string listType) returns json[]|error
Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- listType string - URLs list type (crawled URLs or error URLs)
Return Type
- json[]|error - Successful operation
getGanalyticsOrphanURLs![](/images/permalink.svg)
function getGanalyticsOrphanURLs(string username, string projectSlug, string analysisSlug, string medium, string 'source, int? page, int? size) returns InlineResponse2001|error
List of Orphan URLs
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- medium string - Type of traffic, value: 'organic' (from search engine)or 'social' (from a social network)
- 'source string - Traffic source, value: name of the search engine or social network
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2001|error - Successful operation
getLinksPercentiles![](/images/permalink.svg)
function getLinksPercentiles(string username, string projectSlug, string analysisSlug) returns LinksPercentiles|error
Get inlinks percentiles
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- LinksPercentiles|error - Successful operation
getPageRankLost![](/images/permalink.svg)
function getPageRankLost(string username, string projectSlug, string analysisSlug) returns PageRankLost|error
Lost pagerank
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- PageRankLost|error - Successful operation
getSitemapsReport![](/images/permalink.svg)
function getSitemapsReport(string username, string projectSlug, string analysisSlug) returns SitemapsReport|error
Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- SitemapsReport|error - Successful operation
getSitemapsSamplesOutOfConfig![](/images/permalink.svg)
function getSitemapsSamplesOutOfConfig(string username, string projectSlug, string analysisSlug, int? page, int? size) returns InlineResponse2002|error
Sample list of URLs which were found in your sitemaps but outside of the
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2002|error - Successful operation
getSitemapsSamplesSitemapsOnly![](/images/permalink.svg)
function getSitemapsSamplesSitemapsOnly(string username, string projectSlug, string analysisSlug, int? page, int? size) returns InlineResponse2002|error
Sample list of URLs which were found in your sitemaps, within the project
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2002|error - Successful operation
getLinksTopDomains![](/images/permalink.svg)
function getLinksTopDomains(string username, string projectSlug, string analysisSlug, int? page, int? size) returns InlineResponse2003|error
Top domains
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2003|error - Successful operation
getLinksTopSubdomains![](/images/permalink.svg)
function getLinksTopSubdomains(string username, string projectSlug, string analysisSlug, int? page, int? size) returns InlineResponse2003|error
Top subddomains
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2003|error - Successful operation
getUrls![](/images/permalink.svg)
function getUrls(string username, string projectSlug, string analysisSlug, UrlsQuery payload, string area, int? page, int? size) returns InlineResponse2004|error
Executes a query and returns a paginated response
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- payload UrlsQuery - Query urls
- area string (default "current") - Analysis context to execute the query
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2004|error - Successful operation
getUrlsAggs![](/images/permalink.svg)
function getUrlsAggs(string username, string projectSlug, string analysisSlug, UrlsAggsQueries payload, string area) returns json[]|error
Query aggregator
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- payload UrlsAggsQueries - Aggregated query urls
- area string (default "current") - Analysis context to execute the queries
Return Type
- json[]|error - Successful operation
getUrlsDatamodel![](/images/permalink.svg)
function getUrlsDatamodel(string username, string projectSlug, string analysisSlug, string area) returns CrawlDatamodel|error
Gets an Analysis datamodel
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- area string (default "current") - Analysis context to execute the queries
Return Type
- CrawlDatamodel|error - Successful operation
getUrlsExports![](/images/permalink.svg)
function getUrlsExports(string username, string projectSlug, string analysisSlug, int? page, int? size) returns InlineResponse2005|error
A list of the CSV Exports requests and their current status
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2005|error - Successful operation
createUrlsExport![](/images/permalink.svg)
function createUrlsExport(string username, string projectSlug, string analysisSlug, UrlsQuery payload, string area) returns CsvExportStatus|error
Creates a new UrlExport object and starts a task that will export the results into a csv
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- payload UrlsQuery - Query urls
- area string (default "current") - Analysis context to execute the queries
Return Type
- CsvExportStatus|error - Successful operation
getUrlsExportStatus![](/images/permalink.svg)
function getUrlsExportStatus(string username, string projectSlug, string analysisSlug, string urlExportId) returns CsvExportStatus|error
Checks the status of an CSVUrlExportJob object
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- urlExportId string - Url Export ID
Return Type
- CsvExportStatus|error - Successful operation
getUrlsSuggestedFilters![](/images/permalink.svg)
function getUrlsSuggestedFilters(string username, string projectSlug, string analysisSlug, UrlsAggsQuery payload, string area) returns UrlsAggsQuery|error
Return most frequent segments (= suggested patterns in the previous version)
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- payload UrlsAggsQuery - Aggregated url query
- area string (default "current") - Analysis context to execute the queries
Return Type
- UrlsAggsQuery|error - Successful operation
getUrlDetail![](/images/permalink.svg)
function getUrlDetail(string username, string projectSlug, string analysisSlug, string url, string[]? fields) returns UrlDetail|error
Gets the detail of an URL for an analysis
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- url string - (Urlencoded) Searched URL
- fields string[]? (default ()) - comma separated list of fields to return (c.f. URLs Datamodel)
getUserProjects![](/images/permalink.svg)
function getUserProjects(string username, int? page, int? size) returns InlineResponse2006|error
List all active projects for the user
Parameters
- username string - User's identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2006|error - Successful operation
testUrlRewritingRules![](/images/permalink.svg)
function testUrlRewritingRules(string username, string projectSlug) returns URLRewritingRulesSerializer|error
Match and replace parts of a URL based on rules passed in POST data
Return Type
- URLRewritingRulesSerializer|error - Successful operation
getSavedFilters![](/images/permalink.svg)
function getSavedFilters(string username, string projectSlug, int? page, int? size) returns InlineResponse2007|error
List all the project's saved filters (each filter's name, ID and filter value)
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- page int? (default ()) - Page Number
- size int? (default ()) - Page Size
Return Type
- InlineResponse2007|error - Successful operation
getSavedFilter![](/images/permalink.svg)
function getSavedFilter(string username, string projectSlug, string identifier) returns ProjectSavedFilter|error
Retrieves a specific saved filter's name, ID and filter value
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- identifier string - Saved Filter's identifier
Return Type
- ProjectSavedFilter|error - Successful operation
getProjectUrlsAggs![](/images/permalink.svg)
function getProjectUrlsAggs(string username, string projectSlug, UrlsAggsQueries payload, string area, string? lastAnalysisSlug, int nbAnalyses) returns Default|error
Project Query aggregator
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- payload UrlsAggsQueries - Aggregated query urls
- area string (default "current") - Analysis context to execute the queries
- lastAnalysisSlug string? (default ()) - Last analysis on the trend
- nbAnalyses int (default 20) - Max number of analysis to return
Records![](/images/permalink.svg)
botify: Analysis![](/images/permalink.svg)
Fields
- config string? -
- date_created string? -
- date_finished string? -
- date_last_modified string? - Date of last modified analysis
- date_launched string? -
- features string? -
- id int? -
- name string? -
- slug string? -
- status string? -
- url string? -
- urls_done string? -
- urls_in_queue string? -
- user User -
botify: AnalysisDetail![](/images/permalink.svg)
Fields
- config string? -
- date_finished string? -
- date_last_modified string? - Date of last modified analysis
- date_launched string? -
- failures string? -
- features string? -
- id int? -
- name string? -
- red_button_domain string? -
- slug string? -
- url string? -
- urls_done string? -
- urls_in_queue string? -
- user User -
botify: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - All requests on the Botify API needs to include an API key. The API key can be provided as part of the query string or as a request header. The name of the API key needs to be
Authorization
.
botify: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
botify: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
botify: CrawlDatamodel![](/images/permalink.svg)
Fields
- fields CrawlDatamodelField[] -
- groups CrawlDatamodelGroup[] -
botify: CrawlDatamodelField![](/images/permalink.svg)
Fields
- group string -
- id string -
- multiple boolean -
- name string -
- permissions string[] -
- subtype string -
- 'type string -
botify: CrawlDatamodelGroup![](/images/permalink.svg)
Fields
- id string -
- name string -
botify: CrawlOrphanURLs![](/images/permalink.svg)
Fields
- url string -
- visits int -
botify: CrawlStatistics![](/images/permalink.svg)
Fields
- depth_current int -
- last_upd_dt string -
- pages_dones int -
- pages_dones_2xx int -
- pages_dones_3xx int -
- pages_dones_4xx int -
- pages_dones_5xx int -
- pages_dones_networkerror int -
- pages_dones_xxx int -
- pages_known int -
botify: CrawlStatisticsTime![](/images/permalink.svg)
Fields
- avg_delay CrawlStatisticsTimePoint[] -
- avg_size CrawlStatisticsTimePoint[] -
- frequency string -
- http_code_2xx CrawlStatisticsTimePoint[] -
- http_code_3xx CrawlStatisticsTimePoint[] -
- http_code_4xx CrawlStatisticsTimePoint[] -
- http_code_5xx CrawlStatisticsTimePoint[] -
- http_code_xxx CrawlStatisticsTimePoint[] -
- last_update_date string -
- new_urls CrawlStatisticsTimePoint[] -
botify: CrawlStatisticsTimePoint![](/images/permalink.svg)
Fields
- count int -
- datetime string -
botify: CrawlStatisticsUrls![](/images/permalink.svg)
Fields
- content_type string -
- date string -
- delay_first_byte int -
- delay_last_byte int -
- gzip boolean -
- http int -
- length int -
- redirects_to string? -
- url string -
botify: CsvExportStatus![](/images/permalink.svg)
Fields
- area int? - Analysis context to execute the queries
- date_created string? -
- job_id string? -
- job_status string? -
- job_url string? -
- nb_results int? -
- query UrlsQuery -
- results string? -
botify: Default![](/images/permalink.svg)
botify: DefaultPayload![](/images/permalink.svg)
default payload for object for all HTTP codes that are not covered individually
Fields
- 'error DefaultpayloadError? - Detailed information of error
botify: DefaultpayloadError![](/images/permalink.svg)
Detailed information of error
Fields
- error_code string? - Error Code
- error_detail record {}? - If available, detailed error
- message string? - Error Message
botify: FieldValues![](/images/permalink.svg)
Fields
- count int -
- results FieldValuesResult[] -
botify: FieldValuesResult![](/images/permalink.svg)
Fields
- nb_urls int -
- value string -
botify: InlineResponse200![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results Analysis[]? -
- size int? -
botify: InlineResponse2001![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results CrawlOrphanURLs[]? -
- size int? -
botify: InlineResponse2002![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results string[]? -
- size int? -
botify: InlineResponse2003![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results LinksTopDomains[]? -
- size int? -
botify: InlineResponse2004![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results UrlDetail[]? -
- size int? -
botify: InlineResponse2005![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results CsvExportStatus[]? -
- size int? -
botify: InlineResponse2006![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results Project[]? -
- size int? -
botify: InlineResponse2007![](/images/permalink.svg)
Fields
- count int? -
- next string? -
- page int? -
- previous string? -
- results ProjectSavedFilter[]? -
- size int? -
botify: LinksPercentiles![](/images/permalink.svg)
Fields
- domain string -
- percentiles LinksPercentilesItem[] -
botify: LinksPercentilesItem![](/images/permalink.svg)
Fields
- avg int -
- id int -
- max int -
- metric_total int -
- min int -
- url_total int -
botify: LinksTopDomains![](/images/permalink.svg)
Fields
- domain string -
- follow_links int -
- follow_samples LinksTopDomainsSamples[] -
- nofollow_links int -
- nofollow_samples LinksTopDomainsSamples[] -
- unique_follow_links int -
- unique_nofollow_links int -
botify: LinksTopDomainsSamples![](/images/permalink.svg)
Fields
- sources string[] -
- unique_links int -
- url string -
botify: PageRankLost![](/images/permalink.svg)
Fields
- 'external float -
- non_crawled float -
- robots_txt float -
botify: Project![](/images/permalink.svg)
Fields
- active boolean? -
- current_settings ProjectSettingsSerializer -
- date_created string? -
- name string -
- slug string -
- user User -
botify: ProjectSavedFilter![](/images/permalink.svg)
Fields
- filters record {} -
- identifier string? -
- name string -
botify: ProjectSettingsSerializer![](/images/permalink.svg)
Fields
- allowed_domains string[] -
- blacklisted_domains string[] -
- compare_crawl boolean? -
- crawl_gzip boolean? -
- extra_headers string? -
- google_analytics_account_email string? - Keep email in case user delete his social auth connection
- google_analytics_nb_days int? -
- google_analytics_site_id int? -
- google_social_auth_id int? -
- has_robots_txt string? -
- header_settings string[] -
- max_depth int? -
- max_nb_pages int -
- max_pages_per_sec int? -
- respect_nofollow boolean? -
- sitemaps string[] -
- start_urls string[] -
- user_agent string? -
botify: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
botify: RewritingRuleSerializer![](/images/permalink.svg)
Fields
- ignore_case boolean -
- regex string -
- replace string -
botify: SitemapsReport![](/images/permalink.svg)
Fields
- count int -
- errors SitemapsReportSitemap[] -
- sitemap_indexes SitemapsReportSitemap[] -
- sitemap_only SitemapsReportOnly -
- sitemaps SitemapsReportSitemap[] -
botify: SitemapsReportOnly![](/images/permalink.svg)
Fields
- in_configuration int -
- out_of_configuration int -
botify: SitemapsReportSitemap![](/images/permalink.svg)
Fields
- 'error SitemapsReportSitemapError? -
- file_type string? -
- invalid_urls int? -
- sitemap_indexes string[]? -
- url string -
- valid_urls int? -
botify: SitemapsReportSitemapError![](/images/permalink.svg)
Fields
- message string -
- 'type string -
botify: String![](/images/permalink.svg)
botify: UrlDetail![](/images/permalink.svg)
botify: URLRewritingRulesSerializer![](/images/permalink.svg)
Fields
- rules RewritingRuleSerializer[] -
- urls string[] -
botify: UrlsAgg![](/images/permalink.svg)
Fields
- aggs record {}[]? -
- count int -
botify: UrlsAggs![](/images/permalink.svg)
Fields
- data UrlsAgg? -
- 'error UrlsErrorAgg? -
- status int -
botify: UrlsAggsQuery![](/images/permalink.svg)
Fields
- aggs record {}[]? -
- filters record {}? -
botify: UrlsErrorAgg![](/images/permalink.svg)
Fields
- error_code string -
- message string -
botify: UrlsQuery![](/images/permalink.svg)
Fields
- fields string[]? -
- filters record {}? -
- sort record {}[]? -
botify: User![](/images/permalink.svg)
Fields
- company_name string? -
- date_joined string? -
- email string? -
- first_name string? -
- is_organization string? -
- last_name string? -
- login string? -
- status string? -
- url string? -
Import
import ballerinax/botify;
Metadata
Released date: over 1 year ago
Version: 1.5.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Website & App Building/Search Engine Optimization
Cost/Paid
Contributors