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

# Get link building overview stats

> Returns aggregated summary metrics by default. When the optional `type` parameter is provided, the response switches to a detailed metric-specific payload.



## OpenAPI

````yaml /api/openapi.yaml get /domain-research/overview/stats
openapi: 3.1.0
info:
  title: Beeze API
  version: v1
  description: >
    External Beeze API for pricing intelligence, domain research, AI Search, and
    integrations.
servers:
  - url: https://api.beeze.io/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: AI Search
    description: Results, visibility, sources, competitors, prompts, and tags
  - name: Domain research
    description: Pricing intelligence, backlinks, prospects, overview stats, and trends
  - name: Integrations
    description: Usage for connected third-party integrations
paths:
  /domain-research/overview/stats:
    get:
      tags:
        - Domain research
      summary: Get link building overview stats
      description: >-
        Returns aggregated summary metrics by default. When the optional `type`
        parameter is provided, the response switches to a detailed
        metric-specific payload.
      operationId: getOutreachOverviewStats
      parameters:
        - $ref: '#/components/parameters/FromDate'
        - $ref: '#/components/parameters/ToDate'
        - $ref: '#/components/parameters/ProjectOptional'
        - $ref: '#/components/parameters/Owner'
        - $ref: '#/components/parameters/Locale'
        - $ref: '#/components/parameters/MetricType'
      responses:
        '200':
          description: Summary metrics or detailed metric-specific stats
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/OutreachSummaryResponse'
                  - $ref: '#/components/schemas/OutreachDetailedStatsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    FromDate:
      name: from
      in: query
      required: false
      schema:
        type: string
        format: date
      description: Start date in YYYY-MM-DD format
    ToDate:
      name: to
      in: query
      required: false
      schema:
        type: string
        format: date
      description: End date in YYYY-MM-DD format
    ProjectOptional:
      name: project
      in: query
      required: false
      schema:
        type: string
        minLength: 1
      description: >-
        Project identifier. Accepts project ID, slug, or name within the active
        workspace. If the project name is ambiguous in that workspace, use the
        project slug or project ID. Public project-scoped routes also require
        globally unique project names across workspaces.
    Owner:
      name: owner
      in: query
      required: false
      schema:
        type: string
      description: Filter by responsible person
    Locale:
      name: locale
      in: query
      required: false
      schema:
        type: string
      description: Filter by locale or market code
    MetricType:
      name: type
      in: query
      required: false
      schema:
        type: string
        enum:
          - spendings
          - backlinks
          - traffic
          - dr
          - pricePerBacklink
      description: Metric type for detailed stats or trends
  schemas:
    OutreachSummaryResponse:
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/OutreachSummaryMetrics'
        details:
          type: object
          properties:
            current:
              type: array
              items:
                $ref: '#/components/schemas/OutreachBacklinkEntry'
            previous:
              type: array
              items:
                $ref: '#/components/schemas/OutreachBacklinkEntry'
          required:
            - current
            - previous
        timeRanges:
          type: object
          properties:
            current:
              $ref: '#/components/schemas/OutreachDateRange'
            previous:
              $ref: '#/components/schemas/OutreachDateRange'
          required:
            - current
            - previous
      required:
        - summary
        - details
        - timeRanges
    OutreachDetailedStatsResponse:
      type: object
      additionalProperties: true
      description: >-
        Detailed metric-specific response returned when the `type` query
        parameter is provided on `/domain-research/overview/stats`
      properties:
        totalSpendings:
          type: number
        averageSpending:
          type: number
        averagePricePerBacklink:
          type: number
        highestSpending:
          type: number
        lowestSpending:
          type: number
        totalBacklinks:
          type: number
        highQualityBacklinks:
          type: number
        highTrafficBacklinks:
          type: number
        averageTraffic:
          type: number
        highestTraffic:
          type: number
        lowestTraffic:
          type: number
        medianTraffic:
          type: number
        averageDr:
          type: number
        highestDr:
          type: number
        lowestDr:
          type: number
        medianDr:
          type: number
    OutreachSummaryMetrics:
      type: object
      properties:
        spendings:
          $ref: '#/components/schemas/OutreachMetricComparison'
        backlinks:
          $ref: '#/components/schemas/OutreachMetricComparison'
        traffic:
          $ref: '#/components/schemas/OutreachMetricComparison'
        domainRating:
          $ref: '#/components/schemas/OutreachMetricComparison'
        pricePerBacklink:
          $ref: '#/components/schemas/OutreachMetricComparison'
      required:
        - spendings
        - backlinks
        - traffic
        - domainRating
        - pricePerBacklink
    OutreachBacklinkEntry:
      type: object
      properties:
        responsiblePerson:
          type: string
        finalPrice:
          type: number
        project:
          type: string
        dateReceived:
          type: string
        metrics:
          $ref: '#/components/schemas/OutreachBacklinkMetrics'
        links:
          $ref: '#/components/schemas/OutreachBacklinkLinks'
      required:
        - responsiblePerson
        - finalPrice
        - project
        - dateReceived
        - metrics
        - links
    OutreachDateRange:
      type: object
      properties:
        from:
          type: string
          format: date
        to:
          type: string
          format: date
      required:
        - from
        - to
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        requestId:
          type: string
        instance:
          type: string
      required:
        - status
        - detail
        - code
    OutreachMetricComparison:
      type: object
      properties:
        current:
          type: number
        previous:
          type: number
        percentageChange:
          type: number
      required:
        - current
        - previous
        - percentageChange
    OutreachBacklinkMetrics:
      type: object
      properties:
        domainTraffic:
          type: number
        domainRating:
          type: number
      required:
        - domainTraffic
        - domainRating
    OutreachBacklinkLinks:
      type: object
      properties:
        domain:
          type: string
        article:
          type: string
          format: uri
      required:
        - domain
        - article
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: Missing plan access, feature access, or workspace access
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for external Beeze API access

````