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

# Domain Rank Overview API

> How many keywords a domain ranks in each position bucket, plus rank movement since the last crawl.



## OpenAPI

````yaml openapi.json GET /v1/website/rank-overview
openapi: 3.0.0
info:
  title: ScoutLayer API
  version: 1.0.0
  description: Competitor data. One API.
servers:
  - url: https://api.scoutlayer.io
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/website/rank-overview:
    get:
      tags:
        - website
        - keywords
        - serp
      summary: Get a domain's overall Google ranking distribution
      description: >-
        How many keywords a domain ranks in each position bucket, plus rank
        movement since the last crawl.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: shopify.com
          required: true
          name: target
          in: query
        - schema:
            type: string
            example: US
          required: false
          name: location
          in: query
        - schema:
            type: string
            example: en
          required: false
          name: language
          in: query
      responses:
        '200':
          description: Get a domain's overall Google ranking distribution
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainRankOverview'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: This endpoint is declared but not yet implemented — never charged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The orchestrator failed or was unreachable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    DomainRankOverview:
      type: object
      properties:
        target:
          type: string
        location:
          type: string
        language:
          type: string
        organic:
          type: object
          properties:
            pos1:
              type: integer
            pos2to3:
              type: integer
            pos4to10:
              type: integer
            pos11to20:
              type: integer
            pos21to50:
              type: integer
            pos51to100:
              type: integer
            total:
              type: integer
            estimatedTraffic:
              type: number
            estimatedTrafficCost:
              type: number
            newCount:
              type: integer
            upCount:
              type: integer
            downCount:
              type: integer
            lostCount:
              type: integer
          required:
            - pos1
            - pos2to3
            - pos4to10
            - pos11to20
            - pos21to50
            - pos51to100
            - total
            - estimatedTraffic
            - estimatedTrafficCost
            - newCount
            - upCount
            - downCount
            - lostCount
        paid:
          type: object
          properties:
            pos1:
              type: integer
            pos2to3:
              type: integer
            pos4to10:
              type: integer
            pos11to20:
              type: integer
            pos21to50:
              type: integer
            pos51to100:
              type: integer
            total:
              type: integer
            estimatedTraffic:
              type: number
            estimatedTrafficCost:
              type: number
            newCount:
              type: integer
            upCount:
              type: integer
            downCount:
              type: integer
            lostCount:
              type: integer
          required:
            - pos1
            - pos2to3
            - pos4to10
            - pos11to20
            - pos21to50
            - pos51to100
            - total
            - estimatedTraffic
            - estimatedTrafficCost
            - newCount
            - upCount
            - downCount
            - lostCount
        featuredSnippetCount:
          type: integer
        localPackCount:
          type: integer
        aiOverviewCount:
          type: integer
        checkedAt:
          type: string
      required:
        - target
        - location
        - language
        - organic
        - paid
        - featuredSnippetCount
        - localPackCount
        - aiOverviewCount
        - checkedAt
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key passed as the X-API-Key request header. Recommended for
        server-to-server calls.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key (or OAuth token) passed as a Bearer token in the Authorization
        header.

````