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

# Backlinks Summary API

> Referring domain/backlink counts, spam score, and a link-profile breakdown for a domain.



## OpenAPI

````yaml openapi.json GET /v1/website/backlinks/summary
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/backlinks/summary:
    get:
      tags:
        - website
        - backlinks
      summary: Get a backlink profile summary for a domain
      description: >-
        Referring domain/backlink counts, spam score, and a link-profile
        breakdown for a domain.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: shopify.com
          required: true
          name: target
          in: query
      responses:
        '200':
          description: Get a backlink profile summary for a domain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BacklinkSummary'
        '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:
    BacklinkSummary:
      type: object
      properties:
        target:
          type: string
        rank:
          type: integer
        spamScore:
          type: integer
        backlinks:
          type: integer
        brokenBacklinks:
          type: integer
        referringDomains:
          type: integer
        referringMainDomains:
          type: integer
        referringDomainsNofollow:
          type: integer
        referringIps:
          type: integer
        referringPages:
          type: integer
        crawledPages:
          type: integer
        internalLinksCount:
          type: integer
        externalLinksCount:
          type: integer
        firstSeenAt:
          type: string
          nullable: true
        info:
          type: object
          properties:
            server:
              type: string
              nullable: true
            cms:
              type: string
              nullable: true
            platformTypes:
              type: array
              items:
                type: string
                enum:
                  - cms
                  - blog
                  - ecommerce
                  - forum
                  - wiki
                  - news
                  - social
                  - other
            country:
              type: string
              nullable: true
            ipAddress:
              type: string
              nullable: true
          required:
            - server
            - cms
            - platformTypes
            - country
            - ipAddress
        breakdown:
          type: object
          properties:
            byTld:
              type: object
              additionalProperties:
                type: integer
            byLinkType:
              type: object
              properties:
                anchor:
                  type: integer
                image:
                  type: integer
                redirect:
                  type: integer
                canonical:
                  type: integer
                alternate:
                  type: integer
                meta:
                  type: integer
                other:
                  type: integer
            byAttribute:
              type: object
              additionalProperties:
                type: integer
            byCountry:
              type: object
              additionalProperties:
                type: integer
          required:
            - byTld
            - byLinkType
            - byAttribute
            - byCountry
        checkedAt:
          type: string
      required:
        - target
        - rank
        - spamScore
        - backlinks
        - brokenBacklinks
        - referringDomains
        - referringMainDomains
        - referringDomainsNofollow
        - referringIps
        - referringPages
        - crawledPages
        - internalLinksCount
        - externalLinksCount
        - firstSeenAt
        - info
        - breakdown
        - 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.

````