Pirsch

Pirsch Email Reports API

Schedule and manage recurring email analytics reports

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 /report List scheduled email reports for a domain · List email reports #
Ask an LLM
“Which scheduled email reports are set up for my site?”
“Who receives analytics reports by email for a domain?”
Tell an agent
List the email reports for domain {id}.
Show every scheduled analytics email configured on domain {id}.
POST /report Schedule an analytics email report · Create email report #
Ask an LLM
“How do I get my site's statistics emailed to my team every week?”
“Can I schedule a monthly analytics report to several addresses?”
Tell an agent
Email a report for domain {domain_id} to {emails} every {interval} weeks.
Schedule a report for domain {domain_id} to {emails} at interval {interval} starting {start_date}.
PUT /report Change an email report's schedule · Update email report #
Ask an LLM
“Can I change an existing email report from weekly to monthly?”
“How do I update where the links in an existing report point?”
Tell an agent
Change email report {id} to send every {interval} weeks.
Make the links in email report {id} point to {link_to}.
DELETE /report Cancel a scheduled email report · Delete email report #
Ask an LLM
“How do I stop an analytics email report from being sent?”
“Can I delete one scheduled report and keep the others?”
Tell an agent destructive · confirm first
Delete email report {id}.
Stop sending the scheduled report {id}.

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pirsch/refs/heads/main/openapi/pirsch-email-reports-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-email-reports-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-email-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pirsch Email Reports 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: Email Reports
  description: Schedule and manage recurring email analytics reports
paths:
  /report:
    get:
      operationId: listEmailReports
      summary: List email reports
      tags:
      - Email Reports
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
        description: Domain ID
      responses:
        '200':
          description: Email reports
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailReport'
    post:
      operationId: createEmailReport
      summary: Create email report
      tags:
      - Email Reports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReportRequest'
      responses:
        '200':
          description: Report created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailReport'
    put:
      operationId: updateEmailReport
      summary: Update email report
      tags:
      - Email Reports
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
                interval:
                  type: integer
                link_to:
                  type: string
      responses:
        '200':
          description: Report updated
    delete:
      operationId: deleteEmailReport
      summary: Delete email report
      tags:
      - Email Reports
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Report deleted
components:
  schemas:
    CreateReportRequest:
      type: object
      required:
      - domain_id
      - emails
      - interval
      properties:
        domain_id:
          type: string
        emails:
          type: array
          items:
            type: string
            format: email
        interval:
          type: integer
          description: 0 for monthly, or number of weeks
        reply_to:
          type: string
          format: email
        start_date:
          type: string
          format: date
        link_to:
          type: string
    EmailReport:
      type: object
      properties:
        id:
          type: string
        domain_id:
          type: string
        emails:
          type: array
          items:
            type: string
            format: email
        interval:
          type: integer
        link_to:
          type: string
        next_report:
          type: string
          format: date-time
        reply_to:
          type: string
          format: email
  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.