Module botify

ballerinax/botify Ballerina library

2.0.0

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

  1. Sign in to your Botify account.

  2. Open your account settings and generate an API token in the API section.

  3. Keep the token and your Botify username (and project slug, when working on a project) at hand.

Note: Botify expects the Authorization header in the form Token <your-token>, not Bearer <your-token>. The connector sends the authorization value exactly as you give it, so prefix the token with Token yourself 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.

Copy
import ballerinax/botify;

configurable string apiToken = ?;
configurable string username = ?;

Step 2: Create a Config.toml file with your credentials.

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

Copy
botify:Client botifyClient = check new ({authorization: "Token " + apiToken});

Step 4: Call an operation, for example list the projects of a user.

Copy
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:

Import

import ballerinax/botify;Copy

Other versions

See more...

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


Source repository


Keywords

Vendor/Botify

Area/Marketing & Social Media

Type/Connector


Contributors