> ## 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. # Get a numeric project overview ## OpenAPI ````yaml /openapi.snapshot.json get /projects/{project_id}/overview 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}/overview: get: tags: - analytics summary: Get a numeric project overview operationId: getProjectOverview 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 - description: Rank-history window used for overview comparisons. in: query name: range schema: default: 28d enum: - 7d - 28d - 90d type: string - description: Filter tracked keywords by SERP device. in: query name: device schema: default: all enum: - all - desktop - mobile type: string - description: Filter tracked keywords by exact tag name. in: query name: tag schema: maxLength: 48 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProjectOverview' 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: ProjectOverview: properties: average_position: description: Mean current position among keywords with ranked observations. type: - number - 'null' average_position_delta: description: Previous mean position minus current mean position. type: - number - 'null' keywords_added_this_month: minimum: 0 type: integer last_check_at: format: date-time type: - string - 'null' next_check_at: format: date-time type: - string - 'null' position_distribution: items: properties: count: minimum: 0 type: - integer - 'null' max: minimum: 1 type: integer min: minimum: 1 type: integer required: - min - max - count type: object type: array project_id: example: prj_a00000000000000000000000 pattern: ^prj_[a-z][a-z0-9]{23}$ type: string top_10_count: minimum: 0 type: - integer - 'null' top_10_delta: type: - integer - 'null' top_100_count: minimum: 0 type: - integer - 'null' top_3_count: minimum: 0 type: - integer - 'null' tracked_keyword_count: minimum: 0 type: integer visibility: description: Volume-weighted visibility percentage. maximum: 100 minimum: 0 type: - number - 'null' visibility_delta: description: Visibility change in percentage points. type: - number - 'null' required: - project_id - tracked_keyword_count - keywords_added_this_month - average_position - average_position_delta - top_3_count - top_10_count - top_10_delta - top_100_count - visibility - visibility_delta - position_distribution - last_check_at - next_check_at 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 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 ````