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

# Sync analytics traffic



## OpenAPI

````yaml /openapi.snapshot.json post /projects/{project_id}/analytics/sync
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/{project_id}/analytics/sync:
    post:
      tags:
        - analytics
      summary: Sync analytics traffic
      operationId: syncProjectTraffic
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficSyncSummary'
          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/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Unsupported API version
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Rate limited
      security:
        - ProjectApiKey: []
        - PersonalAccessToken: []
components:
  schemas:
    TrafficSyncSummary:
      properties:
        connections:
          minimum: 0
          type: integer
        keyword_snapshots:
          minimum: 0
          type: integer
        page_snapshots:
          minimum: 0
          type: integer
        project_id:
          pattern: ^prj_[a-z][a-z0-9]{23}$
          type: string
        runs:
          items:
            $ref: '#/components/schemas/TrafficSyncRun'
          type: array
        skipped:
          items:
            properties:
              provider:
                type: string
              reason:
                enum:
                  - no_capability
                  - rate_limited
                type: string
            required:
              - provider
              - reason
            type: object
          type: array
      required:
        - connections
        - keyword_snapshots
        - page_snapshots
        - project_id
        - runs
        - skipped
      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
    TrafficSyncRun:
      properties:
        connection_id:
          pattern: ^conn_[a-z][a-z0-9]{23}$
          type: string
        error:
          type: string
        error_class:
          type: string
        provider:
          type: string
        rows_fetched:
          minimum: 0
          type: integer
        rows_matched:
          minimum: 0
          type: integer
        rows_upserted:
          minimum: 0
          type: integer
        status:
          enum:
            - succeeded_with_data
            - succeeded_empty
            - deferred_rate_limit
            - failed
            - not_applicable
          type: string
        truncated:
          type: boolean
      required:
        - connection_id
        - provider
        - status
        - rows_fetched
        - rows_matched
        - rows_upserted
        - truncated
      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

````