> ## Documentation Index
> Fetch the complete documentation index at: https://bisibility.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Load domain keywords

> Loads one provider-backed keyword page. max_cost_cents is required; use zero for cache-only access.


## OpenAPI

````yaml /openapi.snapshot.json post /projects/{projectId}/domain-overview/keywords
openapi: 3.1.0
info:
  description: >-
    Public REST API for bisibility keyword rank tracking. Clients may optionally
    declare v1 with the Bisibility-API-Version header. Resource IDs use strict
    v3 prefixed public IDs and list cursors are version 3.
  title: bisibility Public API
  version: 1.0.0
servers:
  - url: /api/v1
security: []
tags:
  - description: >-
      Discover the API contract, capabilities, health, and public provider
      pricing.
    name: discovery
    x-group: Discovery
  - description: Manage the authenticated account and personal access tokens.
    name: account-access
    x-group: Account & Access
  - description: Create projects and manage their core settings.
    name: projects
    x-group: Projects
  - description: Create, list, and revoke API keys.
    name: api-keys
    x-group: API Keys
  - description: Manage tracked keywords and exact keyword matching.
    name: keywords
    x-group: Keywords
  - description: Run rank checks and retrieve rank-check history.
    name: rank-checks
    x-group: Rank Checks
  - description: Research keywords, metrics, locations, and ranked keyword suggestions.
    name: keyword-research
    x-group: Keyword Research
  - description: Analyze backlinks and page through backlink snapshots.
    name: backlinks
    x-group: Backlinks
  - description: Analyze domain visibility and load its history, keywords, and pages.
    name: domain-overview
    x-group: Domain Overview
  - description: Read project analytics, traffic snapshots, and search-performance data.
    name: analytics
    x-group: Analytics
  - description: Manage alert rules, triggered alerts, and notification preferences.
    name: alerts
    x-group: Alerts
  - description: Manage project competitors.
    name: competitors
    x-group: Competitors
  - description: Inspect and configure project sitemap monitoring.
    name: sitemap-monitoring
    x-group: Sitemap Monitoring
  - description: Save keywords for later without putting them under rank tracking.
    name: saved-keywords
    x-group: Saved Keywords
  - description: Create, list, and delete saved views.
    name: saved-views
    x-group: Saved Views
  - description: Ingest and list project signals.
    name: signals
    x-group: Signals
  - description: Connect and configure external providers.
    name: providers
    x-group: Providers
  - description: Create and manage webhook endpoints.
    name: webhooks
    x-group: Webhooks
  - description: Manage team members and invitations.
    name: team
    x-group: Team
  - description: Manage migration tokens and instance import sessions.
    name: migration
    x-group: Migration
paths:
  /projects/{projectId}/domain-overview/keywords:
    post:
      tags:
        - domain-overview
      summary: Load domain keywords
      description: >-
        Loads one provider-backed keyword page. max_cost_cents is required; use
        zero for cache-only access.
      operationId: loadDomainOverviewKeywords
      parameters:
        - description: >-
            API contract version requested by the client. Omit this header to
            use the current backward-compatible behavior.
          in: header
          name: Bisibility-API-Version
          required: false
          schema:
            enum:
              - v1
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainOverviewKeywordsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOverviewKeywordsResponse'
          description: JSON response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOverviewProblem'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: snapshot_expired; Unsupported API version
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOverviewProblem'
          description: >-
            unsupported_target, unsupported_location, needs_reauth,
            lookup_failed, or cost_limit_exceeded
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOverviewProblem'
          description: budget_exhausted, in_progress, or rate_limited
      security:
        - ProjectApiKey: []
        - PersonalAccessToken: []
components:
  schemas:
    DomainOverviewKeywordsRequest:
      additionalProperties: false
      properties:
        fresh:
          default: false
          type: boolean
        language_code:
          maxLength: 12
          minLength: 2
          type: string
        limit:
          maximum: 100
          minimum: 1
          type: integer
        location_code:
          minimum: 1
          type: integer
        max_cost_cents:
          minimum: 0
          type: integer
        offset:
          minimum: 0
          type: integer
        scope_override:
          enum:
            - root
            - subdomain
          type: string
        target:
          maxLength: 253
          minLength: 1
          type: string
      required:
        - target
        - location_code
        - language_code
        - limit
        - offset
        - max_cost_cents
      type: object
    DomainOverviewKeywordsResponse:
      properties:
        data:
          properties:
            cached:
              type: boolean
            cost_cents:
              minimum: 0
              type: number
            data:
              $ref: '#/components/schemas/DomainOverviewKeywordsData'
            fetched_at:
              format: date-time
              type: string
          required:
            - cached
            - cost_cents
            - data
            - fetched_at
          type: object
      required:
        - data
      type: object
    Problem:
      properties:
        detail:
          type: string
        docs_url:
          type: string
        errors: {}
        instance:
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      required:
        - type
        - title
        - status
        - detail
        - instance
        - docs_url
      type: object
    DomainOverviewProblem:
      allOf:
        - $ref: '#/components/schemas/Problem'
        - properties:
            errors:
              properties:
                cost_cents:
                  minimum: 0
                  type: number
                reason:
                  type: string
                reset_at:
                  type:
                    - number
                    - 'null'
              required:
                - reason
                - cost_cents
              type: object
          required:
            - errors
          type: object
    DomainOverviewKeywordsData:
      properties:
        cost_cents:
          minimum: 0
          type: number
        rows:
          items:
            properties:
              cpc_cents:
                type:
                  - number
                  - 'null'
              difficulty:
                type:
                  - number
                  - 'null'
              estimated_traffic:
                type:
                  - number
                  - 'null'
              intent:
                enum:
                  - informational
                  - navigational
                  - commercial
                  - transactional
                  - null
                type:
                  - string
                  - 'null'
              keyword:
                type: string
              position:
                type:
                  - number
                  - 'null'
              rank_absolute:
                type:
                  - number
                  - 'null'
              rank_absolute_delta:
                type:
                  - number
                  - 'null'
              ranking_url:
                type:
                  - string
                  - 'null'
              search_volume:
                type:
                  - number
                  - 'null'
              serp_features:
                items:
                  type: string
                type: array
            required:
              - keyword
              - position
              - search_volume
              - estimated_traffic
              - cpc_cents
              - difficulty
              - intent
              - ranking_url
              - serp_features
              - rank_absolute_delta
              - rank_absolute
            type: object
          type: array
        total_count:
          type:
            - integer
            - 'null'
      required:
        - rows
        - total_count
        - cost_cents
      type: object
  securitySchemes:
    ProjectApiKey:
      bearerFormat: bsb_key_live_...
      description: >-
        Project-scoped API key. It cannot access account routes or create
        additional projects.
      scheme: bearer
      type: http
    PersonalAccessToken:
      bearerFormat: bsb_pat_live_...
      description: >-
        Personal access token for account routes and projects visible to the
        authenticated user.
      scheme: bearer
      type: http

````