Pirsch

Pirsch Traffic Management API

Filter traffic and configure spike/warning notifications

GitHub OpenAPI

Operations 7

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 /filter List a domain's traffic filters · List traffic filters #
Ask an LLM
“Which traffic filters are excluding visits from my site's stats?”
“Can I see which IPs or paths I'm currently filtering out?”
Tell an agent
List the traffic filters for domain {domain_id}.
Show every exclusion filter on domain {domain_id}.
POST /filter Create or edit a traffic filter · Create or update traffic filter #
Ask an LLM
“How do I exclude my office IP from my analytics?”
“Can I change the value of a traffic filter I already set up?”
Tell an agent
Add a {type} filter for {filter} on domain {domain_id}.
Update traffic filter {id} on domain {domain_id} to {type} {filter}.
DELETE /filter Delete a traffic filter · Delete traffic filter #
Ask an LLM
“How do I stop excluding traffic that a filter currently blocks?”
“Can I remove one traffic filter and keep the rest?”
Tell an agent destructive · confirm first
Delete traffic filter {id}.
Remove the exclusion filter {id}.
PUT /traffic/spike Turn traffic spike alerts on or off · Toggle spike notifications #
Ask an LLM
“Can I get notified when my site suddenly gets a traffic spike?”
“How do I switch off spike alerts for a site?”
Tell an agent
Toggle traffic spike notifications for domain {domain_id}.
Switch spike alerts on or off for {domain_id}.
POST /traffic/spike Set the traffic spike alert threshold · Configure spike notification threshold #
Ask an LLM
“What counts as a spike, and can I set the threshold myself?”
“How do I raise the level at which spike alerts fire?”
Tell an agent
Set the spike notification threshold for domain {domain_id} to {threshold}.
Alert me about spikes on {domain_id} above {threshold}.
PUT /traffic/warning Turn no-traffic warnings on or off · Toggle traffic warnings #
Ask an LLM
“Can I be warned if my site stops receiving traffic?”
“How do I disable traffic warnings for a domain?”
Tell an agent
Toggle traffic warnings for domain {domain_id}.
Switch no-traffic warnings on or off for {domain_id}.
POST /traffic/warning Set days without traffic before a warning · Configure traffic warning threshold #
Ask an LLM
“How many days without traffic should pass before I'm warned?”
“Can I set the warning threshold to a week of no visits?”
Tell an agent
Warn me when domain {domain_id} has no traffic for {threshold} days.
Set the traffic warning threshold for {domain_id} to {threshold} days.

Documentation

📖
Documentation
https://docs.pirsch.io/api-sdks/api-v1

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pirsch/refs/heads/main/openapi/pirsch-traffic-management-api-openapi.yml

Other Resources

🔗
APIGuide
https://docs.pirsch.io/api-sdks/api-guide-v1
🔗
SDKs
https://docs.pirsch.io/api-sdks/sdks

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/pirsch:pirsch-traffic-management-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.

GitHub Google LinkedIn

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

OpenAPI Specification

pirsch-traffic-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pirsch Traffic Management API
  description: RESTful API for sending page views, events, and session data to Pirsch, and for querying statistics including visitors, pages, referrers, UTM parameters, geo-location, device, browser, conversion goals, funnels, and real-time active visitors. Also exposes management endpoints for domains, members, clients, webhooks, email reports, traffic filters, short links, and views.
  version: '1'
  contact:
    name: Pirsch Support
    url: https://pirsch.io
  license:
    name: Proprietary
    url: https://pirsch.io/privacy
servers:
- url: https://api.pirsch.io/api/v1
  description: Pirsch production API
security:
- BearerAuth: []
tags:
- name: Traffic Management
  description: Filter traffic and configure spike/warning notifications
paths:
  /filter:
    get:
      operationId: listTrafficFilters
      summary: List traffic filters
      tags:
      - Traffic Management
      parameters:
      - name: domain_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Traffic filters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TrafficFilter'
    post:
      operationId: createOrUpdateTrafficFilter
      summary: Create or update traffic filter
      tags:
      - Traffic Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFilterRequest'
      responses:
        '200':
          description: Filter saved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficFilter'
    delete:
      operationId: deleteTrafficFilter
      summary: Delete traffic filter
      tags:
      - Traffic Management
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Filter deleted
  /traffic/spike:
    put:
      operationId: toggleSpikeNotifications
      summary: Toggle spike notifications
      tags:
      - Traffic Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - domain_id
              properties:
                domain_id:
                  type: string
      responses:
        '200':
          description: Spike notifications toggled
    post:
      operationId: configureSpikeNotifications
      summary: Configure spike notification threshold
      tags:
      - Traffic Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - domain_id
              - threshold
              properties:
                domain_id:
                  type: string
                threshold:
                  type: integer
      responses:
        '200':
          description: Spike threshold updated
  /traffic/warning:
    put:
      operationId: toggleTrafficWarnings
      summary: Toggle traffic warnings
      tags:
      - Traffic Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - domain_id
              properties:
                domain_id:
                  type: string
      responses:
        '200':
          description: Traffic warnings toggled
    post:
      operationId: configureTrafficWarnings
      summary: Configure traffic warning threshold
      tags:
      - Traffic Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - domain_id
              - threshold
              properties:
                domain_id:
                  type: string
                threshold:
                  type: integer
                  description: Threshold in days
      responses:
        '200':
          description: Warning threshold updated
components:
  schemas:
    CreateFilterRequest:
      type: object
      required:
      - domain_id
      - type
      - filter
      properties:
        id:
          type: string
        domain_id:
          type: string
        type:
          type: string
        description:
          type: string
        filter:
          type: string
    TrafficFilter:
      type: object
      properties:
        id:
          type: string
        domain_id:
          type: string
        type:
          type: string
        description:
          type: string
        filter:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Pass an OAuth2 access token obtained from POST /token, or a static access key, as a Bearer token in the Authorization header.