Module botify

ballerinax/botify Ballerina library

1.5.2

Overview

The Botify API v1.0.0 connector(https://developers.botify.com/reference) OpenAPI specification.

Botify Saas API comprise data about thousands of relevant SEO metrics, computed through website crawling and server logs ingestion.

Clients

botify: Client

Isolated

This is a generated connector for Botify API v1.0.0 OpenAPI specification. API for Internet Archive's Search-related services.

Constructor

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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)

Return Type

UrlDetail|error - Successful operation

getUserProjects

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function testUrlRewritingRules(string username, string projectSlug) returns URLRewritingRulesSerializer|error

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

Parameters

username string - User's identifier

projectSlug string - Project's identifier

Return Type

URLRewritingRulesSerializer|error - Successful operation

getSavedFilters

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Return Type

Default|error - Successful operation

Records

botify: Analysis

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

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

Closed record

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

Closed record

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

Closed record

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

Fields

fields CrawlDatamodelField[] -

groups CrawlDatamodelGroup[] -

botify: CrawlDatamodelField

Fields

group string -

id string -

multiple boolean -

name string -

permissions string[] -

subtype string -

'type string -

botify: CrawlDatamodelGroup

Fields

id string -

name string -

botify: CrawlOrphanURLs

Fields

url string -

visits int -

botify: CrawlStatistics

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

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

Fields

count int -

datetime string -

botify: CrawlStatisticsUrls

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

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

botify: DefaultPayload

default payload for object for all HTTP codes that are not covered individually

Fields

'error? DefaultpayloadError - Detailed information of error

botify: DefaultpayloadError

Detailed information of error

Fields

error_code? string - Error Code

error_detail? record {} - If available, detailed error

message? string - Error Message

botify: FieldValues

Fields

count int -

results FieldValuesResult[] -

botify: FieldValuesResult

Fields

nb_urls int -

value string -

botify: InlineResponse200

Fields

count? int -

next? string -

page? int -

previous? string -

results? Analysis[] -

size? int -

botify: InlineResponse2001

Fields

count? int -

next? string -

page? int -

previous? string -

results? CrawlOrphanURLs[] -

size? int -

botify: InlineResponse2002

Fields

count? int -

next? string -

page? int -

previous? string -

results? string[] -

size? int -

botify: InlineResponse2003

Fields

count? int -

next? string -

page? int -

previous? string -

results? LinksTopDomains[] -

size? int -

botify: InlineResponse2004

Fields

count? int -

next? string -

page? int -

previous? string -

results? UrlDetail[] -

size? int -

botify: InlineResponse2005

Fields

count? int -

next? string -

page? int -

previous? string -

results? CsvExportStatus[] -

size? int -

botify: InlineResponse2006

Fields

count? int -

next? string -

page? int -

previous? string -

results? Project[] -

size? int -

botify: InlineResponse2007

Fields

count? int -

next? string -

page? int -

previous? string -

results? ProjectSavedFilter[] -

size? int -

botify: LinksPercentiles

Fields

domain string -

percentiles LinksPercentilesItem[] -

botify: LinksPercentilesItem

Fields

avg int -

id int -

max int -

metric_total int -

min int -

url_total int -

botify: LinksTopDomains

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

Fields

sources string[] -

unique_links int -

url string -

botify: PageRankLost

Fields

'external float -

non_crawled float -

robots_txt float -

botify: Project

Fields

active? boolean -

current_settings ProjectSettingsSerializer -

date_created? string -

name string -

slug string -

user User -

botify: ProjectSavedFilter

Fields

filters record {} -

identifier? string -

name string -

botify: ProjectSettingsSerializer

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

Closed record

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

Fields

ignore_case boolean -

regex string -

replace string -

botify: SitemapsReport

Fields

count int -

errors SitemapsReportSitemap[] -

sitemap_indexes SitemapsReportSitemap[] -

sitemap_only SitemapsReportOnly -

sitemaps SitemapsReportSitemap[] -

botify: SitemapsReportOnly

Fields

in_configuration int -

out_of_configuration int -

botify: SitemapsReportSitemap

Fields

'error? SitemapsReportSitemapError -

file_type? string -

invalid_urls? int -

sitemap_indexes? string[] -

url string -

valid_urls? int -

botify: SitemapsReportSitemapError

Fields

message string -

'type string -

botify: String

botify: UrlDetail

botify: URLRewritingRulesSerializer

Fields

rules RewritingRuleSerializer[] -

urls string[] -

botify: UrlsAgg

Fields

aggs? record {}[] -

count int -

botify: UrlsAggs

Fields

data? UrlsAgg -

'error? UrlsErrorAgg -

status int -

botify: UrlsAggsQuery

Fields

aggs? record {}[] -

filters? record {} -

botify: UrlsErrorAgg

Fields

error_code string -

message string -

botify: UrlsQuery

Fields

fields? string[] -

filters? record {} -

sort? record {}[] -

botify: User

Fields

company_name? string -

date_joined? string -

email? string -

first_name? string -

is_organization? string -

last_name? string -

status? string -

url? string -

Array types

botify: jsonArr

json[]

jsonArr

botify: UrlsAggsQueries

UrlsAggsQuery[]

UrlsAggsQueries

Import

import ballerinax/botify;

Other versions

1.5.2

1.5.1 1.5.0 1.4.0 1.2.0

Metadata

Released date: 2 days ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 31

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/Botify

Area/Marketing & Social Media

Website & App Building/Search Engine Optimization

Cost/Paid

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/constraint/1.5.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

arrayTypes

ballerinax/botify Ballerina library

Overview

Clients

botify: Client

Constructor

getProjectAnalyses

Parameters

Return Type

getAnalysisSummary

Parameters

Return Type

getCrawlStatistics

Parameters

Return Type

getCrawlStatisticsByFrequency

Parameters

Return Type

getCrawlStatisticsUrls

Parameters

Return Type

getGanalyticsOrphanURLs

Parameters

Return Type

getLinksPercentiles

Parameters

Return Type

getPageRankLost

Parameters

Return Type

getSitemapsReport

Parameters

Return Type

getSitemapsSamplesOutOfConfig

Parameters

Return Type

getSitemapsSamplesSitemapsOnly

Parameters

Return Type

getLinksTopDomains

Parameters

Return Type

getLinksTopSubdomains

Parameters

Return Type

getUrls

Parameters

Return Type

getUrlsAggs

Parameters

Return Type

getUrlsDatamodel

Parameters

Return Type

getUrlsExports

Parameters

Return Type

createUrlsExport

Parameters

Return Type

getUrlsExportStatus

Parameters

Return Type

getUrlsSuggestedFilters

Parameters

Return Type

getUrlDetail

Parameters

Return Type

getUserProjects

Parameters

Return Type

testUrlRewritingRules

Parameters

Return Type

getSavedFilters

Parameters

Return Type