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

# Website summary

> Returns aggregate web analytics from your Keupera tracking script.



## OpenAPI

````yaml /api-reference/openapi.json get /website/summary
openapi: 3.1.0
info:
  title: Keupera Public API
  version: 1.0.0
  description: >-
    Programmatic access to every major Keupera module — Keyword Research,
    Backlinks, Content, AI Visibility, and Analytics.


    All endpoints are served under `https://app.keupera.com/api/v1` and
    authenticated with a Bearer API key. Responses are JSON and follow a
    consistent `{ "data": ... }` envelope, with list endpoints adding a `meta`
    object for pagination.
  contact:
    name: Keupera Support
    email: ask@support.keupera.com
    url: https://keupera.com
  x-logo:
    url: /logo/light.svg
servers:
  - url: https://app.keupera.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Keywords
    description: >-
      Research, enrich, and manage keywords and keyword groups. List, add,
      delete, star, bulk-update status, trigger AI keyword research jobs, and
      organize keywords into groups.
  - name: Backlinks
    description: >-
      Run backlink research campaigns, manage the opportunities discovered for
      each campaign, and generate or send personalized outreach emails.
  - name: Content
    description: >-
      Plan, generate, update, and publish AI-written articles across the full
      content pipeline, and configure per-website content automation.
  - name: AI Visibility
    description: >-
      Track how your brand and competitors appear across LLM answers via Brand
      Radar campaigns, the Prompt Research Engine, and a consolidated visibility
      score.
  - name: Analytics
    description: >-
      Query website traffic, cached Google Search Console data, and AI bot crawl
      activity for a website.
  - name: Account & Utilities
    description: >-
      Verify credentials, connect CMS integrations, and reference internal
      endpoints.
paths:
  /website/summary:
    get:
      tags:
        - Analytics
      summary: Website summary
      description: Returns aggregate web analytics from your Keupera tracking script.
      operationId: getWebsiteSummary
      parameters:
        - $ref: '#/components/parameters/WebsiteId'
        - $ref: '#/components/parameters/Range'
        - $ref: '#/components/parameters/From'
        - $ref: '#/components/parameters/To'
      responses:
        '200':
          description: Website summary.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebsiteSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    WebsiteId:
      name: website_id
      in: query
      description: >-
        Target website. Defaults to the website bound to your API key. Must
        belong to one of your organizations.
      schema:
        type: string
        format: uuid
    Range:
      name: range
      in: query
      description: Preset date range. Ignored when both `from` and `to` are provided.
      schema:
        type: string
        enum:
          - 7d
          - 30d
          - 90d
        default: 30d
    From:
      name: from
      in: query
      description: Start date (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
    To:
      name: to
      in: query
      description: End date (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
  schemas:
    WebsiteSummary:
      type: object
      properties:
        unique_visitors:
          type: integer
          example: 15420
        total_visits:
          type: integer
          example: 23150
        pageviews:
          type: integer
          example: 45000
        views_per_visit:
          type: number
          example: 1.94
        avg_visit_duration:
          type: number
          description: Average visit duration in seconds.
          example: 185.5
        bounce_rate:
          type: number
          description: Bounce rate as a percentage.
          example: 42.3
    Error:
      type: object
      description: Standard error envelope.
      properties:
        error:
          type: string
          description: Descriptive error message.
  responses:
    Unauthorized:
      description: Unauthorized — missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or missing API key
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your Keupera API key as a Bearer token: `Authorization: Bearer
        YOUR_KEUPERA_API_KEY`. Generate keys from **Account → API Keys** in your
        Keupera dashboard.

````