Scalar Analytics API

The analytics API from Scalar — 4 operation(s) for analytics.

Operations 4

GET /analytics/projects/{projectUid}/overview Getanalytics projects project uid overview #
GET /analytics/projects/{projectUid}/pages Getanalytics projects project uid pages #
GET /analytics/projects/{projectUid}/referrers Getanalytics projects project uid referrers #
GET /analytics/projects/{projectUid}/consumers Getanalytics projects project uid consumers #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/scalar-analytics-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

scalar-analytics-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Scalar Analytics API
  contact:
    name: Marc from Scalar
    url: https://scalar.com
    email: support@scalar.com
  version: '1.0'
  description: 'Operations tagged analytics across 2 of this provider''s published API definitions: scalar-core.json, scalar-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.scalar.com/core
security:
- BearerAuth: []
tags:
- name: Analytics
paths:
  /analytics/projects/{projectUid}/overview:
    get:
      tags:
      - Analytics
      description: KPI totals + timeseries + consumer breakdown for a docs project
      operationId: getanalyticsProjectsProjectUidOverview
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  totals:
                    type: object
                    properties:
                      views:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      unique:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      human:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      bot:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      llm:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      mcp:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                    required:
                    - views
                    - unique
                    - human
                    - bot
                    - llm
                    - mcp
                    additionalProperties: false
                  timeseries:
                    type: array
                    items:
                      type: object
                      properties:
                        bucket:
                          type: string
                        human:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        bot:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        llm:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        mcp:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        unique:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                      - bucket
                      - human
                      - bot
                      - llm
                      - mcp
                      - unique
                      additionalProperties: false
                required:
                - totals
                - timeseries
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      parameters:
      - schema:
          $ref: '#/components/schemas/nanoid'
        in: path
        name: projectUid
        required: true
      - schema:
          default: 7d
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          - 90d
        in: query
        name: range
        required: true
      - schema:
          type: string
          enum:
          - hour
          - day
        in: query
        name: granularity
        required: false
      summary: Getanalytics projects project uid overview
      x-summary-source: derived
  /analytics/projects/{projectUid}/pages:
    get:
      tags:
      - Analytics
      description: Top pages by views for a docs project
      operationId: getanalyticsProjectsProjectUidPages
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  pages:
                    type: array
                    items:
                      type: object
                      properties:
                        path:
                          type: string
                        views:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        unique:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                      - path
                      - views
                      - unique
                      additionalProperties: false
                required:
                - pages
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      parameters:
      - schema:
          $ref: '#/components/schemas/nanoid'
        in: path
        name: projectUid
        required: true
      - schema:
          default: 7d
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          - 90d
        in: query
        name: range
        required: true
      - schema:
          default: 20
          type: integer
          minimum: 1
          maximum: 100
        in: query
        name: limit
        required: true
      summary: Getanalytics projects project uid pages
      x-summary-source: derived
  /analytics/projects/{projectUid}/referrers:
    get:
      tags:
      - Analytics
      description: Top referrers for a docs project
      operationId: getanalyticsProjectsProjectUidReferrers
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  referrers:
                    type: array
                    items:
                      type: object
                      properties:
                        referrer:
                          type: string
                        views:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                      - referrer
                      - views
                      additionalProperties: false
                required:
                - referrers
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      parameters:
      - schema:
          $ref: '#/components/schemas/nanoid'
        in: path
        name: projectUid
        required: true
      - schema:
          default: 7d
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          - 90d
        in: query
        name: range
        required: true
      - schema:
          default: 20
          type: integer
          minimum: 1
          maximum: 100
        in: query
        name: limit
        required: true
      summary: Getanalytics projects project uid referrers
      x-summary-source: derived
  /analytics/projects/{projectUid}/consumers:
    get:
      tags:
      - Analytics
      description: Consumer breakdown (human/bot/llm/mcp) for a docs project
      operationId: getanalyticsProjectsProjectUidConsumers
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  totals:
                    type: object
                    properties:
                      human:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      bot:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      llm:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      mcp:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                    required:
                    - human
                    - bot
                    - llm
                    - mcp
                    additionalProperties: false
                  timeseries:
                    type: array
                    items:
                      type: object
                      properties:
                        bucket:
                          type: string
                        human:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        bot:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        llm:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        mcp:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        unique:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                      - bucket
                      - human
                      - bot
                      - llm
                      - mcp
                      - unique
                      additionalProperties: false
                required:
                - totals
                - timeseries
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      parameters:
      - schema:
          $ref: '#/components/schemas/nanoid'
        in: path
        name: projectUid
        required: true
      - schema:
          default: 7d
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          - 90d
        in: query
        name: range
        required: true
      - schema:
          type: string
          enum:
          - hour
          - day
        in: query
        name: granularity
        required: false
      summary: Getanalytics projects project uid consumers
      x-summary-source: derived
components:
  schemas:
    nanoid:
      type: string
      minLength: 5
    '404':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    '403':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    '422':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    '401':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    '400':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    '500':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    nanoid_2:
      type: string
      minLength: 5
      examples:
      - UakgbKJ5m9gl0JDMbcJqL
    '404_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Resource not found.
        code: not-found
    '403_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: You do not have permission to access this resource.
        code: forbidden
    '422_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: The request body contains invalid values.
        code: invalid-payload
    '401_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Invalid authentication token.
        code: unauthorized
    '400_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Invalid request parameters.
        code: bad-request
    '500_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: An unexpected error occurred.
        code: unknown
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- scalar-core.json
- scalar-openapi.json