Swetrix

Swetrix Annotations API

Manage chart annotations

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/project/annotations/{pid} List a project's chart annotations · List Annotations #
Ask an LLM
“Which notes have been pinned to dates on my analytics charts?”
“Can I see every chart annotation saved for one Swetrix project?”
Tell an agent
List all chart annotations for project {pid}.
Show me the dated notes on the charts of project {pid}.
POST /v1/project/annotation Add a note to a chart on a specific date · Create Annotation #
Ask an LLM
“How do I mark a release date on my traffic chart with a note?”
“Can I add a text annotation to a specific day in a project's analytics?”
Tell an agent
Add an annotation to project {pid} on {date} saying {text}.
Mark {date} on the charts of project {pid} with the note {text}.
PATCH /v1/project/annotation Change an existing annotation's date or text · Update Annotation #
Ask an LLM
“Can I fix the wording of a chart annotation I already added?”
“Is it possible to move an existing annotation to a different date?”
Tell an agent
Change the text of annotation {id} in project {pid} to {text}.
Move existing annotation {id} in project {pid} to {date}.
DELETE /v1/project/annotation/{id}/{pid} Remove an annotation from a project · Delete Annotation #
Ask an LLM
“How do I get rid of a chart annotation I no longer need?”
“What happens to the chart note when I delete an annotation?”
Tell an agent destructive · confirm first
Delete annotation {id} from project {pid}.
Remove the chart note {id} on project {pid}.

Documentation

📖
Documentation
https://swetrix.com/docs/statistics-api
📖
Documentation
https://swetrix.com/docs/admin-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/swetrix/openapi/swetrix-annotations-api-openapi.yml

Other Resources

🔗
Overlay
https://artifacts.apis.io/swetrix/overlays/swetrix-annotations-api-overlay.yaml
🔗
PostmanCollection
https://artifacts.apis.io/swetrix/postman/swetrix-annotations-api.postman_collection.json
🔗
OpenCollection
https://artifacts.apis.io/swetrix/collections/swetrix-annotations-api.opencollection.json

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/swetrix:swetrix-annotations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

swetrix-annotations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Swetrix Admin Annotations API
  description: The Swetrix Admin API manages analytics projects, funnels, annotations, project views (segments), and organisations. Supports full CRUD operations for all Swetrix account resources. All requests require authentication via the X-Api-Key header. Rate limit is 600 requests/hour.
  version: '1.0'
  contact:
    name: Swetrix Support
    url: https://swetrix.com/contact
  termsOfService: https://swetrix.com/privacy
  license:
    name: AGPL-3.0
    url: https://github.com/Swetrix/swetrix-api/blob/main/LICENSE
servers:
- url: https://api.swetrix.com
  description: Swetrix Production API
security:
- ApiKeyAuth: []
tags:
- name: Annotations
  description: Manage chart annotations
paths:
  /v1/project/annotations/{pid}:
    get:
      operationId: listAnnotations
      summary: List Annotations
      description: Retrieves all chart annotations for a project.
      tags:
      - Annotations
      parameters:
      - name: pid
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      responses:
        '200':
          description: Array of annotations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Annotation'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/project/annotation:
    post:
      operationId: createAnnotation
      summary: Create Annotation
      description: Creates a new chart annotation for a project on a specific date.
      tags:
      - Annotations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnnotationRequest'
            example:
              pid: abc123projectid
              date: '2026-05-01'
              text: Launched v2.0
      responses:
        '201':
          description: Annotation created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Annotation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    patch:
      operationId: updateAnnotation
      summary: Update Annotation
      description: Updates an existing annotation's date or text.
      tags:
      - Annotations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAnnotationRequest'
      responses:
        '200':
          description: Updated annotation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Annotation'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/project/annotation/{id}/{pid}:
    delete:
      operationId: deleteAnnotation
      summary: Delete Annotation
      description: Removes an annotation from a project.
      tags:
      - Annotations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Annotation ID
      - name: pid
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      responses:
        '204':
          description: Annotation deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    BadRequest:
      description: Bad request - malformed body or missing required fields
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    Unauthorized:
      description: Unauthorized - missing or invalid API key
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  schemas:
    UpdateAnnotationRequest:
      type: object
      required:
      - id
      - pid
      properties:
        id:
          type: string
        pid:
          type: string
        date:
          type: string
          format: date
        text:
          type: string
          maxLength: 120
    CreateAnnotationRequest:
      type: object
      required:
      - pid
      - date
      - text
      properties:
        pid:
          type: string
        date:
          type: string
          format: date
          description: Date for the annotation (YYYY-MM-DD)
        text:
          type: string
          maxLength: 120
          description: Annotation text
    Annotation:
      type: object
      properties:
        id:
          type: string
        pid:
          type: string
        date:
          type: string
          format: date
        text:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key from Swetrix account settings (https://swetrix.com/user-settings)
externalDocs:
  description: Swetrix Admin API Documentation
  url: https://swetrix.com/docs/admin-api