botify
Module botify
API
Definitions
ballerinax/botify Ballerina library
Overview
The Botify connector provides programmatic access to the Botify SaaS API, which exposes SEO crawl, log and search analytics for websites. This connector supports version 1.0 of the Botify REST API and lets Ballerina integrations read projects, analyses and crawl results, query URL data, and run exports and jobs.
Key features
- Browse projects, analyses and saved filters of a Botify account
- Retrieve crawl statistics, sitemap reports, link metrics and scoring summaries for an analysis
- Query URL datasets and run aggregation queries against an analysis or a whole project
- Create and track CSV URL exports and asynchronous jobs
Setup guide
-
Sign in to your Botify account.
-
Open your account settings and generate an API token in the API section.
-
Keep the token and your Botify username (and project slug, when working on a project) at hand.
Note: Botify expects the
Authorizationheader in the formToken <your-token>, notBearer <your-token>. The connector sends theauthorizationvalue exactly as you give it, so prefix the token withTokenyourself when creating the client (see Step 3 below).
Quickstart
To use the Botify connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module and declare the configuration.
import ballerinax/botify; configurable string apiToken = ?; configurable string username = ?;
Step 2: Create a Config.toml file with your credentials.
apiToken = "<your-botify-api-token>" username = "<your-botify-username>"
Step 3: Create a client. Pass the token with the Token prefix; a bare token is rejected by Botify.
botify:Client botifyClient = check new ({authorization: "Token " + apiToken});
Step 4: Call an operation, for example list the projects of a user.
public function main() returns error? { botify:UserProjectsList _ = check botifyClient->getUserProjects(username); }
Examples
The Botify connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Site crawl health report - Collect a project's analyses and report crawl statistics and sitemap coverage for the latest one.
- Crawl data export workflow - Validate fields against the datamodel, start a URL export and wait for it to finish.
Clients
botify: Client
Client for the Botify SaaS API, which provides SEO crawl, log and search analytics for websites. It covers projects, analyses, crawl reports, URL queries, exports and jobs.
Constructor
Gets invoked to initialize the connector.
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
function getProjectAnalyses(string username, string projectSlug, map<string|string[]> headers, *GetProjectAnalysesQueries queries) returns ProjectAnalysesList|errorList project analyses
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- queries *GetProjectAnalysesQueries - Queries to be sent with the request
Return Type
- ProjectAnalysesList|error - error payload
launchAnalysisCreate
function launchAnalysisCreate(string username, string projectSlug, map<string|string[]> headers) returns AnalysisCreateAndLaunch|errorCreate and launch an analysis
Return Type
- AnalysisCreateAndLaunch|error - error payload
getProjectAnalysesLight
function getProjectAnalysesLight(string username, string projectSlug, map<string|string[]> headers, *GetProjectAnalysesLightQueries queries) returns ProjectAnalysesLightList|errorList project analyses in light format
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- queries *GetProjectAnalysesLightQueries - Queries to be sent with the request
Return Type
- ProjectAnalysesLightList|error - error payload
getAnalysisSummary
function getAnalysisSummary(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetAnalysisSummaryQueries queries) returns AnalysisDetail|errorGet analysis details
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetAnalysisSummaryQueries - Queries to be sent with the request
Return Type
- AnalysisDetail|error - error payload
getCrawlStatistics
function getCrawlStatistics(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns CrawlStatistics|errorGet crawl statistics
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- CrawlStatistics|error - error payload
getCrawlStatisticsByFrequency
function getCrawlStatisticsByFrequency(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetCrawlStatisticsByFrequencyQueries queries) returns CrawlStatisticsTime|errorGet crawl statistics by time frequency
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetCrawlStatisticsByFrequencyQueries - Queries to be sent with the request
Return Type
- CrawlStatisticsTime|error - error payload
getCrawlStatisticsUrls
function getCrawlStatisticsUrls(string username, string projectSlug, string analysisSlug, "crawled"|"errors" listType, map<string|string[]> headers) returns CrawlStatisticsUrls[]|errorList latest crawled URLs
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- listType "crawled"|"errors" - URLs list type (crawled URLs or error URLs)
Return Type
- CrawlStatisticsUrls[]|error - error payload
getGanalyticsOrphanURLs
function getGanalyticsOrphanURLs(string username, string projectSlug, string analysisSlug, "organic"|"social" medium, "all"|"aol"|"ask"|"baidu"|"bing"|"facebook"|"google"|"google+"|"linkedin"|"naver"|"pinterest"|"reddit"|"tumblr"|"twitter"|"yahoo"|"yandex" 'source, map<string|string[]> headers, *GetGanalyticsOrphanURLsQueries queries) returns VisitsOrphanUrlsPage|errorList Google Analytics orphan URLs
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- medium "organic"|"social" - Type of traffic, value: 'organic' (from search engine)or 'social' (from a social network)
- 'source "all"|"aol"|"ask"|"baidu"|"bing"|"facebook"|"google"|"google+"|"linkedin"|"naver"|"pinterest"|"reddit"|"tumblr"|"twitter"|"yahoo"|"yandex" - Traffic source, value: name of the search engine or social network
- queries *GetGanalyticsOrphanURLsQueries - Queries to be sent with the request
Return Type
- VisitsOrphanUrlsPage|error - error payload
getLinksPercentiles
function getLinksPercentiles(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns LinksPercentiles|errorGet inlinks percentiles
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- LinksPercentiles|error - error payload
getPageRankLost
function getPageRankLost(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns PageRankLost|errorGet lost PageRank
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- PageRankLost|error - error payload
getScoring
function getScoring(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns ScoringSummary|errorGet scoring summary
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- ScoringSummary|error - error payload
getKeywordsStats
function getKeywordsStats(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns KeywordsStats|errorGet search console clicks and impressions
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- KeywordsStats|error - error payload
getSitemapsReport
function getSitemapsReport(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns SitemapsReport|errorGet sitemaps report
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- SitemapsReport|error - error payload
getSitemapsSamplesOutOfConfig
function getSitemapsSamplesOutOfConfig(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetSitemapsSamplesOutOfConfigQueries queries) returns SitemapOnlySamplesPage|errorList sitemap URLs outside the crawl configuration
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetSitemapsSamplesOutOfConfigQueries - Queries to be sent with the request
Return Type
- SitemapOnlySamplesPage|error - error payload
getSitemapsSamplesSitemapsOnly
function getSitemapsSamplesSitemapsOnly(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetSitemapsSamplesSitemapsOnlyQueries queries) returns SitemapOnlySamplesPage|errorList URLs found only in sitemaps
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetSitemapsSamplesSitemapsOnlyQueries - Queries to be sent with the request
Return Type
- SitemapOnlySamplesPage|error - error payload
getLinksTopDomains
function getLinksTopDomains(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetLinksTopDomainsQueries queries) returns LinksTopSubdomainsPage|errorList top linking domains
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetLinksTopDomainsQueries - Queries to be sent with the request
Return Type
- LinksTopSubdomainsPage|error - error payload
getLinksTopSubdomains
function getLinksTopSubdomains(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetLinksTopSubdomainsQueries queries) returns LinksTopSubdomainsPage|errorList top linking subdomains
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetLinksTopSubdomainsQueries - Queries to be sent with the request
Return Type
- LinksTopSubdomainsPage|error - error payload
getVisitsOrphanURLs
function getVisitsOrphanURLs(string username, string projectSlug, string analysisSlug, "organic"|"social" medium, "all"|"aol"|"ask"|"baidu"|"bing"|"facebook"|"google"|"google+"|"linkedin"|"naver"|"pinterest"|"reddit"|"tumblr"|"twitter"|"yahoo"|"yandex" 'source, map<string|string[]> headers, *GetVisitsOrphanURLsQueries queries) returns VisitsOrphanUrlsPage|errorList visits orphan URLs
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- medium "organic"|"social" - Type of traffic, value: 'organic' (from search engine)or 'social' (from a social network)
- 'source "all"|"aol"|"ask"|"baidu"|"bing"|"facebook"|"google"|"google+"|"linkedin"|"naver"|"pinterest"|"reddit"|"tumblr"|"twitter"|"yahoo"|"yandex" - Traffic source, value: name of the search engine or social network
- queries *GetVisitsOrphanURLsQueries - Queries to be sent with the request
Return Type
- VisitsOrphanUrlsPage|error - error payload
pauseAnalysis
function pauseAnalysis(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns AnalysisPause|errorPause an analysis
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- AnalysisPause|error - error payload
resumeAnalysis
function resumeAnalysis(string username, string projectSlug, string analysisSlug, map<string|string[]> headers) returns AnalysisResume|errorResume an analysis
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
Return Type
- AnalysisResume|error - error payload
getAnalysisSegments
function getAnalysisSegments(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetAnalysisSegmentsQueries queries) returns AnalysisSegmentsList|errorGet analysis segments
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetAnalysisSegmentsQueries - Queries to be sent with the request
Return Type
- AnalysisSegmentsList|error - error payload
getRobotsTxtIndexesView
function getRobotsTxtIndexesView(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetRobotsTxtIndexesViewQueries queries) returns RobotsTxtFile|errorList robots.txt files
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetRobotsTxtIndexesViewQueries - Queries to be sent with the request
Return Type
- RobotsTxtFile|error - error payload
getRobotsTxtFileView
function getRobotsTxtFileView(string username, string projectSlug, string analysisSlug, string robotsTxt, map<string|string[]> headers, *GetRobotsTxtFileViewQueries queries) returns RobotsTxtFile|errorGet robots.txt file content
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- robotsTxt string - Filename
- queries *GetRobotsTxtFileViewQueries - Queries to be sent with the request
Return Type
- RobotsTxtFile|error - error payload
getUrls
function getUrls(string username, string projectSlug, string analysisSlug, Request request, map<string|string[]> headers, *GetUrlsQueries queries) returns UrlsPage|errorQuery analysis URLs
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- request Request - Query
- queries *GetUrlsQueries - Queries to be sent with the request
getUrlsAggs
function getUrlsAggs(string username, string projectSlug, string analysisSlug, Request request, map<string|string[]> headers, *GetUrlsAggsQueries queries) returns Aggs[]|errorRun analysis URL aggregation queries
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- request Request - AggsQueries
- queries *GetUrlsAggsQueries - Queries to be sent with the request
getUrlAI
function getUrlAI(string username, string projectSlug, string analysisSlug, string url, map<string|string[]> headers) returns UrlAI|errorGet AI suggestions for a URL
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- url string - Searched URL as a raw, unencoded URL (for example
https://www.example.com/); it is URL-encoded once when the request path is built
getUrlsDatamodel
function getUrlsDatamodel(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetUrlsDatamodelQueries queries) returns Datamodel|errorGet analysis datamodel
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetUrlsDatamodelQueries - Queries to be sent with the request
getUrlsDatasets
function getUrlsDatasets(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetUrlsDatasetsQueries queries) returns Datasets|errorGet analysis datasets
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetUrlsDatasetsQueries - Queries to be sent with the request
getUrlsExports
function getUrlsExports(string username, string projectSlug, string analysisSlug, map<string|string[]> headers, *GetUrlsExportsQueries queries) returns UrlsExportsList|errorList URL exports
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- queries *GetUrlsExportsQueries - Queries to be sent with the request
Return Type
- UrlsExportsList|error - error payload
createUrlsExport
function createUrlsExport(string username, string projectSlug, string analysisSlug, Request request, map<string|string[]> headers, *CreateUrlsExportQueries queries) returns CsvExportStatus|errorCreate a URL export
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- request Request - Query
- queries *CreateUrlsExportQueries - Queries to be sent with the request
Return Type
- CsvExportStatus|error - error payload
getUrlsExportStatus
function getUrlsExportStatus(string username, string projectSlug, string analysisSlug, string urlExportId, map<string|string[]> headers) returns CsvExportStatus|errorGet URL export status
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- urlExportId string - Url Export ID
Return Type
- CsvExportStatus|error - error payload
getUrlHTML
function getUrlHTML(string username, string projectSlug, string analysisSlug, string url, map<string|string[]> headers) returns UrlHTML|errorGet URL HTML
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- url string - Searched URL as a raw, unencoded URL (for example
https://www.example.com/); it is URL-encoded once when the request path is built
getUrlDetail
function getUrlDetail(string username, string projectSlug, string analysisSlug, string url, map<string|string[]> headers, *GetUrlDetailQueries queries) returns UrlDetail|errorGet URL details
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- analysisSlug string - Analysis' identifier
- url string - Searched URL as a raw, unencoded URL (for example
https://www.example.com/); it is URL-encoded once when the request path is built
- queries *GetUrlDetailQueries - Queries to be sent with the request
getJobs
List jobs
Parameters
- queries *GetJobsQueries - Queries to be sent with the request
createJob
Create a job
Parameters
- request Request - Job create
Return Type
- JobResults|error - error payload
getJob
Get a job
Parameters
- jobId string - the id of the job to retrieve
Return Type
- JobResults|error - error payload
getUserProjects
function getUserProjects(string username, map<string|string[]> headers, *GetUserProjectsQueries queries) returns UserProjectsList|errorList user projects
Parameters
- username string - User's identifier
- queries *GetUserProjectsQueries - Queries to be sent with the request
Return Type
- UserProjectsList|error - error payload
getAccountSavedFilters
function getAccountSavedFilters(string username, string projectSlug, map<string|string[]> headers, *GetAccountSavedFiltersQueries queries) returns SavedFiltersList|errorList account saved filters
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- queries *GetAccountSavedFiltersQueries - Queries to be sent with the request
Return Type
- SavedFiltersList|error - error payload
getProjectCollections
function getProjectCollections(string username, string projectSlug, map<string|string[]> headers) returns Collection|errorList project collections
Return Type
- Collection|error - error payload
getCollectionDetail
function getCollectionDetail(string username, string projectSlug, string collection, map<string|string[]> headers, *GetCollectionDetailQueries queries) returns CollectionDatasets|errorGet collection details
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- collection string - The collection to query
- queries *GetCollectionDetailQueries - Queries to be sent with the request
Return Type
- CollectionDatasets|error - error payload
getSavedFilters
function getSavedFilters(string username, string projectSlug, map<string|string[]> headers, *GetSavedFiltersQueries queries) returns SavedFiltersList|errorList project saved filters
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- queries *GetSavedFiltersQueries - Queries to be sent with the request
Return Type
- SavedFiltersList|error - error payload
getFilter
function getFilter(string username, string projectSlug, string identifier, map<string|string[]> headers) returns ProjectSavedFilter|errorGet a saved filter
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- identifier string - Identifier of the saved, account or recommended filter
Return Type
- ProjectSavedFilter|error - error payload
projectQuery
function projectQuery(string username, string projectSlug, Request request, map<string|string[]> headers, *ProjectQueryQueries queries) returns ProjectQueryResult|errorQuery project collections
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- request Request - Project Query
- queries *ProjectQueryQueries - Queries to be sent with the request
Return Type
- ProjectQueryResult|error - error payload
getSavedExplorers
function getSavedExplorers(string username, string projectSlug, map<string|string[]> headers) returns SavedExplorer|errorList saved explorers
Return Type
- SavedExplorer|error - error payload
getProjectUrlsAggs
function getProjectUrlsAggs(string username, string projectSlug, Request request, map<string|string[]> headers, *GetProjectUrlsAggsQueries queries) returns UrlsAggsResponse|errorRun project aggregation queries
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- request Request - AggsQueries
- queries *GetProjectUrlsAggsQueries - Queries to be sent with the request
Return Type
- UrlsAggsResponse|error - error payload
cloneValuesList
function cloneValuesList(string username, string projectSlug, Request request, map<string|string[]> headers) returns ValuesListCloneResponse|errorClone keyword groups to another project
Parameters
- username string - User's identifier
- projectSlug string - Project's identifier
- request Request - JSON body to use as request body for ValuesList clone operation
Return Type
- ValuesListCloneResponse|error - error payload
getDatasourcesSummaryByProjects
function getDatasourcesSummaryByProjects(string username, map<string|string[]> headers) returns ProjectDatasourceSummary|errorGet datasources summary by project
Parameters
- username string - User's identifier
Return Type
- ProjectDatasourceSummary|error - error payload
getAllUserProjects
List all user projects
Parameters
- username string - User's identifier
Records
botify: Aggs
Fields
- 'error? ErrorAgg -
- status int -
botify: Analysis
Fields
- urlsInQueue? string -
- redButtonDomain? string -
- hasRawPages? string -
- excludedFromTrends boolean(default false) -
- toBeDeletedAt? string -
- features? string -
- importKeywordsDataByCountry boolean(default true) -
- slug? string -
- dateLaunched? string -
- dateLastModified? string - Date of last modified analysis
- owner? string -
- friendlyName? string -
- failures? string -
- dateCreated? string -
- computingRevision? string -
- urlsDone? string -
- url? string -
- crawlLaunchType? string -
- dateCrawlDone? string -
- dateFinished? string -
- importKeywordsData? string -
- name? string -
- pk? string -
- user User -
- config? string -
- comparable? string -
- status? string -
botify: AnalysisCreateAndLaunch
Create and Launch Analysis
botify: AnalysisDetail
Fields
- urlsInQueue? string -
- redButtonDomain? string -
- hasRawPages? string -
- excludedFromTrends boolean(default false) -
- toBeDeletedAt? string -
- features? string -
- importKeywordsDataByCountry boolean(default true) -
- slug? string -
- dateLaunched? string -
- dateLastModified? string - Date of last modified analysis
- owner? string -
- friendlyName? string -
- failures? string -
- dateCreated? string -
- computingRevision? string -
- urlsDone? string -
- url? string -
- crawlLaunchType? string -
- dateCrawlDone? string -
- dateFinished? string -
- importKeywordsData? string -
- name? string -
- privateConfig? string -
- pk? string -
- user User -
- config? string -
- comparable? string -
- status? string -
botify: AnalysisPause
Pause Analysis
botify: AnalysisResume
Resume Analysis
botify: AnalysisSegments
Analysis Segments
Fields
- segments? string - Public metadata of the segments defined for the analysis
botify: AnalysisSegmentsList
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? AnalysisSegments[] -
botify: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - Botify API token, sent as
Token <your-token>(not Bearer)
botify: Collection
Fields
- date? string -
- dateStart? string -
- timestamped boolean -
- genericName? string -
- name string -
- dateEnd? string -
- id string -
botify: CollectionDatasets
Fields
- metadata? CollectionMetadata -
- datasets Dataset[] -
botify: CollectionMetadata
Fields
- dateStart? string -
- dateEnd? string -
- config? record {} -
- dateLastModified? string -
botify: ConnectionConfig
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(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - 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
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
botify: CrawlOrphanURLs
Fields
- visits? int -
- url? string -
botify: CrawlStatistics
Fields
- pagesDones2xx int -
- pagesDones3xx int -
- pagesDones4xx int -
- pagesDones5xx int -
- crawlerIp? string -
- pagesDonesXxx int -
- pagesDonesNetworkerror int -
- pagesDones int -
- pagesKnown int -
- lastUpdDt string -
- depthCurrent int -
botify: CrawlStatisticsTime
Fields
- avgSize CrawlStatisticsTimePoint[] -
- frequency string -
- httpCode4xx CrawlStatisticsTimePoint[] -
- avgDelay CrawlStatisticsTimePoint[] -
- httpCode3xx CrawlStatisticsTimePoint[] -
- retryLater? CrawlStatisticsTimePoint[] -
- httpCode5xx CrawlStatisticsTimePoint[] -
- httpCodeXxx CrawlStatisticsTimePoint[] -
- httpResourcesCode2xx? CrawlStatisticsTimePoint[] -
- httpResourcesCode4xx? CrawlStatisticsTimePoint[] -
- newUrls CrawlStatisticsTimePoint[] -
- httpResourcesCode3xx? CrawlStatisticsTimePoint[] -
- httpResourcesCode5xx? CrawlStatisticsTimePoint[] -
- httpResourcesCodeXxx? CrawlStatisticsTimePoint[] -
- httpCode2xx CrawlStatisticsTimePoint[] -
- lastUpdateDate string -
botify: CrawlStatisticsTimePoint
Fields
- datetime string -
- count int -
botify: CrawlStatisticsUrls
Fields
- date string -
- contentType string -
- redirectsTo? string -
- length int -
- http int -
- delayFirstByte int -
- gzip boolean -
- delayLastByte int -
- url string -
botify: CreateUrlsExportQueries
Represents the Queries record for the operation: createUrlsExport
Fields
- area "current"|"disappeared"|"new"|"search_engines_orphans"|"gsc_keywords"|"gsc_keywords_by_country" (default "current") - Analysis context
- size? Signed32 - Maximum size of the export
- previousCrawl? string - Previous analysis identifier
- compression "zip"|"gzip" (default "gzip") - Compressed file format
- exportSize? Signed32 - Maximum size of the export (deprecated => size instead)
botify: CsvExportStatus
Fields
- nbResults? int -
- area string(default "0") -
- jobStatus? string -
- size int -
- jobId? string -
- dateCreated? string -
- query Query - Query
- jobUrl? string -
- results? string -
- user? string -
botify: Datamodel
Fields
- aliases? record {} -
- groups DatamodelGroup[] -
- maxTimeseriesFields? int -
- fields DatamodelField[] -
botify: DatamodelField
Fields
- aliases? string[] -
- subtype string -
- permissions string[] -
- suggestion? boolean -
- multiple boolean -
- name string -
- optional boolean -
- id string -
- 'type string -
- group string -
botify: DatamodelGroup
Fields
- name string -
- id string -
botify: Dataset
Fields
- suggestedOperations? SuggestedOperations[] -
- name string -
- multiple? boolean -
- groups DatasetGroup[] -
- id string -
- fields DatasetField[] -
- category string[] -
botify: DatasetField
Fields
- settings? record {} -
- aliases? string[] -
- kind string -
- suggestion? boolean -
- deprecated? boolean -
- multiple boolean -
- optional boolean -
- 'type string -
- subtype string -
- permissions string[] -
- meta? record {} -
- name string -
- id string -
- group? string -
botify: DatasetGroup
Fields
- parent? string -
- default? string -
- name string -
- multiple? boolean -
- options? record {}[] -
- description? string -
- id string -
- 'type? string -
botify: Datasets
Fields
- datasets Dataset[] -
botify: ErrorAgg
Fields
- errorCode string -
- message string -
botify: GetAccountSavedFiltersQueries
Represents the Queries record for the operation: getAccountSavedFilters
Fields
- search? string - Search query on the filter name
- disableProject boolean(default false) - Flag to return or not filters of this project
- size? Signed32 - Page Size
- page? Signed32 - Page Number
botify: GetAnalysisSegmentsQueries
Represents the Queries record for the operation: getAnalysisSegments
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetAnalysisSummaryQueries
Represents the Queries record for the operation: getAnalysisSummary
Fields
- previousCrawl? string - Previous analysis identifier
botify: GetCollectionDetailQueries
Represents the Queries record for the operation: getCollectionDetail
Fields
- sequenced boolean(default false) - Whether to use sequenced groups
botify: GetCrawlStatisticsByFrequencyQueries
Represents the Queries record for the operation: getCrawlStatisticsByFrequency
Fields
- 'limit? Signed32 - max number of elements to retrieve
- frequency "1mn"|"5mn"|"60mn" - Aggregation frequency
botify: GetGanalyticsOrphanURLsQueries
Represents the Queries record for the operation: getGanalyticsOrphanURLs
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetJobsQueries
Represents the Queries record for the operation: getJobs
Fields
- jobType? string - The job type
- size? int - Page Size
- project? string - The project slug
- page int(default 1) - Page Number
- analysis? string - The analysis slug
botify: GetLinksTopDomainsQueries
Represents the Queries record for the operation: getLinksTopDomains
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetLinksTopSubdomainsQueries
Represents the Queries record for the operation: getLinksTopSubdomains
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetProjectAnalysesLightQueries
Represents the Queries record for the operation: getProjectAnalysesLight
Fields
- size? Signed32 - Page Size
- onlySuccess boolean(default true) - Return only successfully finished analyses
- page int(default 1) - Page Number
botify: GetProjectAnalysesQueries
Represents the Queries record for the operation: getProjectAnalyses
Fields
- size? Signed32 - Page Size
- onlySuccess boolean(default true) - Return only successfully finished analyses
- page int(default 1) - Page Number
- fields? string - Which fields to return (comma-separated)
botify: GetProjectUrlsAggsQueries
Represents the Queries record for the operation: getProjectUrlsAggs
Fields
- area "current"|"disappeared"|"new"|"gsc_keywords"|"gsc_keywords_by_country" (default "current") - Analyses context
- lastAnalysisSlug? string - Last analysis on the trend
- nbAnalyses Signed32(default 20) - Max number of analysis to return
botify: GetRobotsTxtFileViewQueries
Represents the Queries record for the operation: getRobotsTxtFileView
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetRobotsTxtIndexesViewQueries
Represents the Queries record for the operation: getRobotsTxtIndexesView
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetSavedFiltersQueries
Represents the Queries record for the operation: getSavedFilters
Fields
- search? string - Search query on the filter name
- size? Signed32 - Page Size
- page? Signed32 - Page Number
botify: GetSitemapsSamplesOutOfConfigQueries
Represents the Queries record for the operation: getSitemapsSamplesOutOfConfig
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetSitemapsSamplesSitemapsOnlyQueries
Represents the Queries record for the operation: getSitemapsSamplesSitemapsOnly
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetUrlDetailQueries
Represents the Queries record for the operation: getUrlDetail
Fields
- fields? string[] - comma separated list of fields to return (c.f. URLs Datamodel)
botify: GetUrlsAggsQueries
Represents the Queries record for the operation: getUrlsAggs
Fields
- area "current"|"disappeared"|"new"|"search_engines_orphans"|"gsc_keywords"|"gsc_keywords_by_country" (default "current") - Analysis context
- previousCrawl? string - Previous analysis identifier
botify: GetUrlsDatamodelQueries
Represents the Queries record for the operation: getUrlsDatamodel
Fields
- area "current"|"disappeared"|"new"|"search_engines_orphans"|"gsc_keywords"|"gsc_keywords_by_country" (default "current") - Analysis context
- previousCrawl? string - Previous analysis identifier
botify: GetUrlsDatasetsQueries
Represents the Queries record for the operation: getUrlsDatasets
Fields
- area "current"|"disappeared"|"new"|"search_engines_orphans"|"gsc_keywords"|"gsc_keywords_by_country" (default "current") - Analysis context
- deprecatedFields boolean(default true) - Include deprecated fields
- previousCrawl? string - Previous analysis identifier
- sequenced boolean(default false) - Whether to use sequenced groups
botify: GetUrlsExportsQueries
Represents the Queries record for the operation: getUrlsExports
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: GetUrlsQueries
Represents the Queries record for the operation: getUrls
Fields
- area "current"|"disappeared"|"new"|"search_engines_orphans"|"gsc_keywords"|"gsc_keywords_by_country" (default "current") - Analysis context
- size? Signed32 - Page Size
- previousCrawl? string - Previous analysis identifier
- page? Signed32 - Page Number
botify: GetUserProjectsQueries
Represents the Queries record for the operation: getUserProjects
Fields
- size? int - Page Size
- name? string - Project's name
- page int(default 1) - Page Number
botify: GetVisitsOrphanURLsQueries
Represents the Queries record for the operation: getVisitsOrphanURLs
Fields
- size? int - Page Size
- page int(default 1) - Page Number
botify: JobResults
Job results
Fields
- jobType string - Type of the job, which determines the payload it expects
- jobStatus? string - Current status of the job
- metadata? record {} - Additional metadata of the job
- payload? string - Payload the job was created with
- jobId? string - Unique identifier of the job
- dateCreated? string - Date and time the job was created
- crawlDate? string - Date of the crawl the job relates to
- jobUrl? string - URL to retrieve the job
- results? string - Results of the job once it has finished
- user? string - User who created the job
botify: JobsList
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? JobResults[] -
botify: KeywordsStat
Fields
- data KeywordsStatData[] -
- 'type string -
- url? string -
botify: KeywordsStatData
Fields
- date int -
- all KeywordsStatDetail -
- tablet KeywordsStatDetail -
- desktop KeywordsStatDetail -
- mobile KeywordsStatDetail -
botify: KeywordsStatDetail
Fields
- sampledImpressions int -
- clicks int -
- impressions int -
- sampledClicks int -
botify: KeywordsStats
Fields
- stats KeywordsStat[] -
botify: LightAnalysis
Fields
- friendlyName? string -
- urlsInQueue? string -
- hasRawPages? boolean - If yes, this crawl has raw HTML pages
- dateCreated? string -
- excludedFromTrends? boolean - If yes, this crawl will be excluded from trends data
- urlsDone? string -
- toBeDeletedAt? string -
- url? string -
- dateFinished? string -
- name? string -
- pk? string -
- comparable boolean(default true) -
- slug string -
- dateLaunched? string -
- dateLastModified? string - Date of last modified analysis
- status? string -
botify: LinksPercentiles
Fields
- percentiles LinksPercentilesItem[] -
- domain string -
botify: LinksPercentilesItem
Fields
- min int -
- metricTotal int -
- avg int -
- urlTotal int -
- max int -
- id int -
botify: LinksTopDomains
Fields
- followSamples LinksTopDomainsSamples[] -
- nofollowSamples LinksTopDomainsSamples[] -
- domain string -
- followLinks int -
- nofollowLinks int -
- uniqueFollowLinks int -
- uniqueNofollowLinks int -
botify: LinksTopDomainsSamples
Fields
- uniqueLinks int -
- sources string[] -
- url string -
botify: LinksTopSubdomainsPage
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? LinksTopDomains[] -
botify: OrganizationUser
Fields
- owner User -
- name? string -
- isOrganization? string -
- slug? string -
- email? string -
botify: PageRankLost
Fields
- nonCrawled float -
- robotsTxt float -
- 'external float -
botify: Project
Fields
- lastCrawlsRevisions? string -
- hasWebVitalsFieldData boolean -
- roles? string -
- realkeywordsAggregationType? int - If 'New: By website & by URL' is selected, data will be shown aggregated by website wherever possible in RealKeywords
- hasActionboard? string -
- hasKeywords? string -
- hasSpeedworkers? string -
- maxExtracts int -
- publicId? int -
- hasCrawl boolean -
- lastActionboardRevision? string -
- hasLogs boolean -
- permissions? string -
- hasEngagementAnalytics boolean -
- mcp? string -
- hasGenAi boolean -
- slug string -
- hasAiConsent? string -
- lastLogRevision? string -
- webproperty WebProperty -
- hasActionboardChanges? string -
- hasSmartlink? string -
- maxGscWebsites? int -
- dateCreated? string -
- actionboardEnabled boolean -
- hasAlertpanel? string -
- maxGscViaBqWebsites? int - Maximum number of GSC properties that can be activated using BigQuery bulk export
- url? string -
- hasAgenticCatalog? string -
- accountId? string -
- hasSmartcontent? string -
- organization OrganizationUser -
- name string -
- pk? string -
- category string(default "0") -
- currentSettings ProjectSettings -
- hasPageworkers? string -
botify: ProjectAnalysesLightList
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? LightAnalysis[] -
botify: ProjectAnalysesList
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? Analysis[] -
botify: ProjectDatasourceSummary
Fields
- runnable? string -
- stats? string -
- datasource string -
- lastRevisionStatus? string -
- dateLastSuccessfulRevision? string -
- segments? string -
botify: ProjectQueryQueries
Represents the Queries record for the operation: projectQuery
Fields
- size? Signed32 - Page Size
- page? Signed32 - Page Number
botify: ProjectQueryResult
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? QueryResponses[] -
botify: ProjectSavedFilter
Project's saved UrlFilter
Fields
- identifier? string - Identifier of the saved filter
- name string - Name of the saved filter
- description? string - Description of the saved filter
- filters record {} - Filter expression stored in the saved filter
- createdDate? string - Date and time the saved filter was created
- 'type? string - Type of the saved filter
- projectName? string - Name of the project the filter belongs to
botify: ProjectSettings
Fields
- startUrlsUrl? record {} -
- urlsList UrlsList -
- maxNbPages int -
- gscWebsites? record {} - List of GSC websites to import (list of objects with the following keys: mandatory fields:
property,type,status,project_id,dataset_id. optional fields:export_log_table_name,searchdata_url_impression_table_name,searchdata_site_impression_table_name,gcp_project_for_client. The last 4 ones can only be edited in the admin, and are used to customize the table names and gcp_project for querying in BQ
- allowedDomains string[] -
- maxDepth? int -
- googleAnalyticsNbDays? int -
- hasVisitsProvider boolean -
- compareCrawl? boolean -
- googleSocialAuthId? int -
- headerSettings string[] -
- keywordsGroupsMaxRulesPerProject? int -
- googleAnalyticsAccountEmail? string - Keep email in case user delete his social auth connection
- sitemaps string[] -
- crawlGzip? boolean -
- jsCrawl? boolean -
- startUrls string[] -
- userAgent? string -
- blacklistedDomains string[] -
- extraHeaders? string -
- respectNofollow? boolean -
- maxPagesPerSec? int -
- isProviderGa4Configured? string -
- googleAnalyticsSiteId? int -
- hasRobotsTxt? string -
- pk? string -
botify: Query
Query
Fields
- filters? record {} - Filter expression restricting the rows returned by the query
- sort? string[] - Fields to sort the results by, in order of priority
- fields? string[] - Fields to return for each row of the result
botify: QueryResponses
Query Responses
Fields
- results? string[] - Results returned for the query
botify: RobotsTxtFile
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? UrlsAggsResponse[] -
botify: SavedExplorer
Project's saved explorer
Fields
- query record {} - Query stored in the saved explorer
- name string - Name of the saved explorer
- modifiedBy? User - User who last modified the saved explorer
- description? string - Description of the saved explorer
- createdDate? string - Date and time the saved explorer was created
- 'type? string - Type of the saved explorer
- modifiedDate? string - Date and time the saved explorer was last modified
- uuid? string - Unique identifier of the saved explorer
- createdBy? User - User who created the saved explorer
botify: SavedFiltersList
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? ProjectSavedFilter[] -
botify: ScoringSummary
Fields
- results record {} -
botify: SitemapOnlySamplesPage
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? string[] -
botify: SitemapsReport
Fields
- sitemapIndexes? SitemapsReportSitemap[] -
- sitemaps? SitemapsReportSitemap[] -
- count? int -
- sitemapOnly? SitemapsReportOnly -
- errors? SitemapsReportSitemap[] -
botify: SitemapsReportOnly
Fields
- inConfiguration? int -
- outOfConfiguration? int -
botify: SitemapsReportSitemap
Fields
- sitemapIndexes? string[] -
- invalidUrls? int -
- fileType? string -
- validUrls? int -
- 'error? SitemapsReportSitemapError -
- lastModified? string -
- url? string -
botify: SitemapsReportSitemapError
Fields
- 'type? string -
- message? string -
botify: SubscriptionPlan
Fields
- smartActivation? string -
- alertPanel? string -
- dataRetention? string -
- plan string -
- startDate string -
botify: SuggestedOperations
Fields
- meta record {} -
- name string -
- operation record {} -
- group? string -
botify: UrlAI
Fields
- result string -
botify: UrlDetail
botify: UrlHTML
botify: UrlsAggsResponse
botify: UrlsExportsList
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? CsvExportStatus[] -
botify: UrlsList
Fields
- countValid? int -
- sampleInvalid? record {} -
- urlsFile string -
- domains? record {} -
- sampleValid? record {} -
- countInvalid? int -
- status? int -
botify: UrlsPage
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? UrlDetail[] -
botify: User
Fields
- companyName? string -
- lastName? string -
- dateJoined? string -
- login? string -
- isOrganization? string -
- firstName? string -
- email? string -
- url? string -
- status? string -
botify: UserProjectsList
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? Project[] -
botify: ValuesListCloneResponse
botify: VisitsOrphanUrlsPage
Fields
- next? string -
- previous? string -
- size? int -
- count? int -
- page? int -
- results? CrawlOrphanURLs[] -
botify: WebProperty
Fields
- currentSubscriptionPlan SubscriptionPlan -
- renewalSubscriptionPlan SubscriptionPlan -
- domain string -
- name string -
- publicId string -
Import
import ballerinax/botify;Metadata
Released date: about 16 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 49
Current verison: 1
Weekly downloads
Keywords
Vendor/Botify
Area/Marketing & Social Media
Type/Connector
Contributors