Pirsch

Pirsch User API

Manage the authenticated user account

GitHub OpenAPI

Operations 9

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 /user Get my account details · Get account details #
Ask an LLM
“What account information does Pirsch have on me?”
“Which email and name are on my account?”
Tell an agent
Show my account details.
Get the profile of the signed-in user.
POST /user/name Change my full name · Update full name #
Ask an LLM
“How do I change the name shown on my account?”
“Can I update my full name?”
Tell an agent
Change my full name to {full_name}.
Set the name on my account to {full_name}.
POST /user/email Change my account email address · Update email address #
Ask an LLM
“How do I move my account to a new email address?”
“Is a confirmation code needed to change my login email?”
Tell an agent
Change my email to {email}.
Confirm my new email {email} with code {code}.
POST /user/password Change my password · Change password #
Ask an LLM
“How do I change my account password?”
“What do I need to provide to set a new password?”
Tell an agent
Change my password from {current_password} to {password}, confirmed as {confirm_password}.
Replace current password {current_password} with {password} and confirm {confirm_password}.
POST /user/language Change my interface language · Change interface language #
Ask an LLM
“Can I switch the dashboard interface to German?”
“Which setting controls the language of my account interface?”
Tell an agent
Set my interface language to {language}.
Switch my dashboard to {language}.
POST /user/filter Change my default dashboard time range · Change default time range #
Ask an LLM
“Can the dashboard open on the last 30 days by default?”
“Where do I change the default time range I see?”
Tell an agent
Set my default time range to {default_time_range}.
Make {default_time_range} the period my dashboard opens with.
GET /user/news Get release news and announcements · Get news #
Ask an LLM
“What's new in the latest product releases?”
“Are there any announcements I haven't seen yet?”
Tell an agent
Show the latest release news.
List recent product announcements for my account.
POST /user/news Mark news items as read · Mark news as read #
Ask an LLM
“How do I dismiss announcements I've already read?”
“Can I mark release news as read?”
Tell an agent
Mark news {news} as read.
Dismiss the announcements {news}.
GET /user/rewards Get my affiliate referral rewards · Get affiliate rewards #
Ask an LLM
“How much have I earned from affiliate referrals?”
“Can I see a summary of my referral rewards?”
Tell an agent
Show my affiliate rewards.
Summarize the referral rewards I've earned.

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pirsch/refs/heads/main/openapi/pirsch-user-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-user-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-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pirsch User 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: User
  description: Manage the authenticated user account
paths:
  /user:
    get:
      operationId: getUser
      summary: Get account details
      description: Get the authenticated user's account information
      tags:
      - User
      responses:
        '200':
          description: User account details
          content:
            application/json:
              schema:
                type: object
  /user/name:
    post:
      operationId: updateUserName
      summary: Update full name
      tags:
      - User
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - full_name
              properties:
                full_name:
                  type: string
      responses:
        '200':
          description: Name updated
  /user/email:
    post:
      operationId: updateUserEmail
      summary: Update email address
      tags:
      - User
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  format: email
                password:
                  type: string
                code:
                  type: string
      responses:
        '200':
          description: Email updated
  /user/password:
    post:
      operationId: updateUserPassword
      summary: Change password
      tags:
      - User
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - current_password
              - password
              - confirm_password
              properties:
                current_password:
                  type: string
                password:
                  type: string
                confirm_password:
                  type: string
      responses:
        '200':
          description: Password changed
  /user/language:
    post:
      operationId: updateUserLanguage
      summary: Change interface language
      tags:
      - User
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - language
              properties:
                language:
                  type: string
      responses:
        '200':
          description: Language updated
  /user/filter:
    post:
      operationId: updateUserFilter
      summary: Change default time range
      tags:
      - User
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - default_time_range
              properties:
                default_time_range:
                  type: string
      responses:
        '200':
          description: Default filter updated
  /user/news:
    get:
      operationId: getUserNews
      summary: Get news
      description: Get release news and announcements
      tags:
      - User
      responses:
        '200':
          description: News items
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    news:
                      type: integer
                    date:
                      type: string
                      format: date-time
                    version:
                      type: string
                    headline:
                      type: string
                    content:
                      type: string
    post:
      operationId: markNewsRead
      summary: Mark news as read
      tags:
      - User
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - news
              properties:
                news:
                  type: integer
      responses:
        '200':
          description: News marked as read
  /user/rewards:
    get:
      operationId: getUserRewards
      summary: Get affiliate rewards
      description: Get affiliate referral rewards summary
      tags:
      - User
      responses:
        '200':
          description: Rewards
          content:
            application/json:
              schema:
                type: object
                properties:
                  sum:
                    type: number
                  count:
                    type: integer
                  rewards:
                    type: array
                    items:
                      type: object
components:
  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.