API Documentation

Get all broken links (4xx, 5xx status codes).

Get redirect chains and final destinations.

Find duplicate titles, descriptions, and content.

Get SEO issues: missing titles, short descriptions, etc.

Get page performance metrics (load times, sizes).

Get discovered resources (images, CSS, JS).

Get Schema.org structured data found on pages.

Compare two crawl jobs.

Query params: baseline_job_id, compare_job_id

Get hreflang tag analysis

Get XML sitemaps found during crawl

Get sitemap URL coverage analysis

Get pagination pattern analysis

Get comprehensive statistics

Get thin content pages

Get heading structure analysis

Get internal link analysis

Get external link analysis

Get orphan pages (no inlinks)

Get indexability report

Get robots.txt analysis

Get canonical tag analysis

Get performance metrics

Get title tag analysis

Get meta description analysis

Get image alt text analysis

Get structured data overview

Get structured data validation errors

Get international hreflang report

Get all SEO issues with filtering

Export as CSV.

Query param: scope (all, internal, external, errors)

Export as JSON.

Query param: scope (all, internal, external, errors)

Export as XML Sitemap.

List all visual sitemaps in a workspace.

Create a new visual sitemap. Body: { name, workspace_id }

Get sitemap details including all nodes and hierarchy.

Update sitemap properties.

Create a new node. Body: { title, url, parent_node_id, node_type, status }

Update node properties. Body fields: title, url, path, status, action (keep, update, review, remove, redirect, merge), redirect_to (destination URL when action is redirect), page_type, assigned_to, category_id, tags, menu_ids, meta_description, target_keywords, notes

Delete a node (children become orphans).

Update positions of multiple nodes. Body: { positions: [{ id, x, y }] }

Export sitemap as JSON, CSV, standalone HTML, or redirect map.

Query params: format (json, csv, html, redirects, redirects_json), theme (light, dark — HTML only), color (blue, purple, green, red, orange, teal, indigo, pink, cyan, amber, lime, slate — HTML only), redirect_code (301 or 302 — redirects formats only, default: 301)

Redirect Map CSV (format=redirects): Downloads a CSV with columns: Source URL, Destination URL, Status Code, Redirect Type, Chain Length, Notes. Aggregates crawl-detected 3xx chains, content audit redirect decisions, sitemap URL changes, and sitemap nodes marked as redirect.

Redirect Map JSON (format=redirects_json): Returns { redirects: [...], summary: { total, crawl_detected, user_decision, url_changed, node_redirect } }

Delete sitemap

Duplicate sitemap node

Import sitemap from URL

Import nodes into sitemap

List detected changes

Detect changes since last crawl

Acknowledge a change

Bulk acknowledge changes

Get available users for assignment

Get pages where node URL was found

Get node content

Get node SEO data

Get node comments

Add comment to node

Update comment

Delete comment

Get sitemap activity log

List sitemap shares

Create sitemap share link

Update share settings

Delete share

Access shared sitemap

Capture screenshot for node

Get sitemap taxonomy

Get sitemap navigation menus

Create category

Update category

Delete category

Create tag

Update tag

Delete tag

Get AI analysis of sitemap structure and suggestions.

Get AI suggestions for improving site structure.

Get scheduled plans

Schedule plan execution

Cancel scheduled plan

Get AI notifications

Mark notification as read

Mark all notifications as read

Get AI activity log

Run AI-powered SEO audit

Get SEO audit history

List content templates

Get template details

Create content template

Apply template to nodes

Get analytics integration config

Get low-performing pages

Get page analytics data

Get AI improvement suggestions

Dismiss suggestion

Accept and apply suggestion

Get content inventory for a crawl job.

Query params: page, per_page, content_type, status_code, search

Get inventory statistics (counts by type, status).

Sync inventory from crawl data (rebuilds inventory table).

Get navigation overview statistics (menus, items, unmapped pages).

Run AI detection to identify navigation menus from page content.

Get all detected navigation menus with items.

Get navigation issues (orphan pages, broken links, duplicates).

Create navigation menu

Update menu

Delete menu

Get specific menu

List navigation items

Get pages for navigation assignment

Create navigation item

Update navigation item

Delete navigation item

Reorder navigation items

Reorder single item

Get page navigation info

Get navigation labels

Update navigation label

Get breadcrumb trails

Get page breadcrumb

Update page breadcrumb

Get pages assigned to menus

Bulk unassign menu items

AI: Analyze navigation

AI: Auto-create navigation

AI: Get pages for selection

Export taxonomy as JSON. Query: include_drafts (true/false).

Export taxonomy as CSV (spreadsheet format).

Export taxonomy as SKOS RDF/XML (W3C standard).

Get taxonomy statistics

Get full taxonomy tree

Update taxonomy term

Delete taxonomy term

Move term to new parent

Export taxonomy (JSON/CSV)

Import taxonomy from file

Import SKOS taxonomy

Get taxonomy changelog

List taxonomy versions

Create taxonomy version snapshot

Delete taxonomy version

Get term change history

Export changelog

Get governance statistics

Bulk change term status

Change individual term status

List taxonomy tags

Create taxonomy tag

Update taxonomy tag

Delete taxonomy tag

Assign tags to term

Get tags for term

Get term relationships

Add term synonym

Add related term

Add use-for relationship

Delete relationship

Get taxonomy thesaurus view

AI: Detect site industry

AI: Search BARTOC vocabularies

AI: Preview BARTOC vocabulary

AI: Import BARTOC vocabulary

AI: List starter taxonomies

AI: Import starter taxonomy

AI: List standard vocabularies

AI: Get vocabulary types

AI: Import standard vocabulary

AI: Import SKOS file

AI: Get classification statistics

AI: Get page classifications

AI: Get export statistics

List all workspaces for the current user.

Create a new workspace.

{
  "name": "My Workspace",
  "description": "Optional description",
  "visibility": "private"
}

Get workspace details.

Update workspace name, description, or visibility.

Delete a workspace (owner only).

List workspace members and their roles.

Invite a user to the workspace.

{
  "email": "[email protected]",
  "role": "member"
}

List all scheduled jobs.

Create a new schedule.

{
  "name": "Daily Crawl",
  "url": "https://example.com",
  "cron_expression": "0 2 * * *",
  "timezone": "UTC",
  "config": {"max_pages": 100}
}

Update schedule (pause/resume with is_active param).

Trigger schedule to run immediately.

Delete a schedule.

Get schedule details

Toggle schedule active/inactive

Get schedule run history

Clean up orphaned schedule jobs

List generated reports.

Generate a new report.

{
  "job_id": 1,
  "report_type": "summary",  // summary, detailed, audit
  "output_format": "html"    // html, pdf, csv, json, xlsx
}

Download a generated report as HTML or PDF file.

Returns: Streaming file download with Content-Disposition header

Register a new user and organization.

{
  "email": "[email protected]",
  "password": "securepassword",
  "org_name": "My Company",
  "name": "John Doe"
}

Login and receive JWT token.

{
  "email": "[email protected]",
  "password": "securepassword"
}

Response

{
  "access_token": "eyJhbG...",
  "user": {"id": 1, "email": "...", "name": "..."}
}

Get current user info. Requires Authorization header with JWT token.

Header: Authorization: Bearer <token>

Get current user's theme preferences.

Response

{
  "theme_color": "blue",
  "text_size": 100,
  "theme_mode": "light"
}

Save user's theme preferences.

{
  "theme_color": "purple",   // blue, purple, green, red, orange, teal, indigo, pink, cyan, amber, lime, slate
  "text_size": 110,          // 80-120
  "theme_mode": "dark"       // light, dark, system
}

List all extraction rules. Returns { rules: [...], count }.

Get a single extraction rule by ID.

Create an extraction rule.

{
  "name": "Product Prices",
  "rule_type": "css",              // css, xpath, regex
  "selector": ".product-price",
  "target": "text",                // text, html, attribute, count
  "target_attribute": null,        // required when target = "attribute"
  "description": "Extract prices from product pages",
  "required": false,               // fail page if extraction fails?
  "default_value": null,           // fallback if extraction fails
  "match_all": false,              // all matches or first only
  "regex_group": 0                 // capture group for regex rules
}

Update an extraction rule. Send only the fields you want to change.

Delete an extraction rule.

Test an extraction rule against a live URL without saving it.

{
  "url": "https://example.com/product/123",
  "rule": {
    "rule_type": "css",
    "selector": ".product-price",
    "target": "text"
  }
}

Retrieve data extracted by custom rules during a crawl. Returns results grouped by field name with success/failure counts.

Query Parameters:

• field_name — Filter by specific field (optional)
• limit — Max results, default 100, max 500
• offset — Pagination offset, default 0

// Response
{
  "data": [
    {
      "page_url": "https://example.com/product/1",
      "rule_name": "Product Prices",
      "field_name": "price",
      "extracted_value": "$29.99",
      "extraction_success": true
    }
  ],
  "count": 42,
  "by_field": {
    "price": { "count": 42, "success": 40 },
    "title": { "count": 42, "success": 42 }
  }
}

List users in organization.

{
  "email": "[email protected]",
  "role": "member"  // owner, admin, member, viewer
}

List pending invitations.

Remove user from organization.

Update user roles.

Revoke invitation.

Resend invitation email.

Leave organization.

Get seat usage and limits.

Add paid seats.

Remove paid seats.

Get invitation details.

Get pending invitations for user.

Accept invitation.

Decline invitation.