Pirsch Documentation

Appearance

API ​

This document describes the API endpoints used to interact with Pirsch. The easiest way to get started is to use one of the client SDKs. If you're looking for how to integrate Pirsch into your backend to collect traffic, please see the server-side integration.

If you're just getting started, we recommend reading the API guide.

INFO

Note that the examples do not necessarily show correct data. IDs from a request may not match the response. You should also be careful not to confuse IDs in their context. Fields are often just called id, but they represent different objects.

Getting an Access Token ​

In order to make requests to the API, you must first obtain an access token or use an access key (write-only). The token must be sent with each request in the Authorisation header in the format Bearer <token>. If you receive a status code of 401 (unauthorized), you must create a new token and try again. The `expires_at' timezone is set to UTC.

The examples for the other endpoints in this document omit the header.

POST https://api.pirsch.io/api/v1/token

EXAMPLE REQUEST
JSON
{
    "client_id": "<client_id>",
    "client_secret": "<client_secret>"
}
{
    "client_id": "<client_id>",
    "client_secret": "<client_secret>"
}
EXAMPLE RESPONSE
JSON
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI...",
    "expires_at": "2020-12-12T00:11:39.903607271Z"
}
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI...",
    "expires_at": "2020-12-12T00:11:39.903607271Z"
}

Sending Page Views ​

This endpoint is used to send page views to Pirsch. It requires you to send information about the request made by the client. How you get this information depends on the programming language and framework you're using. The example shows which fields are required and which are optional. We recommend sending all of them to make the results as accurate as possible.

POST https://api.pirsch.io/api/v1/hit

EXAMPLE REQUEST
JSON
{
    "url":                          "https://example.com/full/url?including=parameters",
    "ip":                           "123.456.789.0",
    "dnt":                          "DNT header (optional)",
    "user_agent":                   "User-Agent header",
    "accept_language":              "Accept-Language header (optional)",
    "sec_ch_ua":                    "Sec-CH-UA header (optional)",
	"sec_ch_ua_mobile":             "Sec-CH-UA-Mobile header (optional)",
	"sec_ch_ua_platform":           "Sec-CH-UA-Platform header (optional)",
	"sec_ch_ua_platform_version":   "Sec-CH-UA-Platform-Version header (optional)",
	"sec_ch_width":                 "Sec-CH-Width header (optional)",
    "sec_ch_viewport_width":        "Sec-CH-Viewport-Width header (optional)",
    "title":                        "Page title (optional)",
    "referrer" :                    "Referer header (optional)",
    "screen_width":                 1920,
    "screen_height":                1080
}
{
    "url":                          "https://example.com/full/url?including=parameters",
    "ip":                           "123.456.789.0",
    "dnt":                          "DNT header (optional)",
    "user_agent":                   "User-Agent header",
    "accept_language":              "Accept-Language header (optional)",
    "sec_ch_ua":                    "Sec-CH-UA header (optional)",
	"sec_ch_ua_mobile":             "Sec-CH-UA-Mobile header (optional)",
	"sec_ch_ua_platform":           "Sec-CH-UA-Platform header (optional)",
	"sec_ch_ua_platform_version":   "Sec-CH-UA-Platform-Version header (optional)",
	"sec_ch_width":                 "Sec-CH-Width header (optional)",
    "sec_ch_viewport_width":        "Sec-CH-Viewport-Width header (optional)",
    "title":                        "Page title (optional)",
    "referrer" :                    "Referer header (optional)",
    "screen_width":                 1920,
    "screen_height":                1080
}

One small tweak you can make is to check the DNT (Do Not Track) header before sending the request. Check if the header is set to 1, if true you can ignore the request, otherwise send it.

It's possible to send multiple page views at once. If you use the batch endpoint, make sure the page views are in order, otherwise they throw off your statistics. This works well for sites that run on a single server where you can buffer page views.

POST https://api.pirsch.io/api/v1/hit/batch

EXAMPLE REQUEST
JSON
[
    {
        // Same parameters as for singe page views, plus the time the request was made to your server.
        "time": "2023-01-02T14:15:32Z"
    },
    // ...
]
[
    {
        // Same parameters as for singe page views, plus the time the request was made to your server.
        "time": "2023-01-02T14:15:32Z"
    },
    // ...
]

Sending Events ​

This endpoint is used to send events to Pirsch. It requires you to send information about the request made by the client. How you get this depends on the programming language and framework you're using. The example shows which fields are required and which are optional. We recommend sending all of them to make the results as accurate as possible.

POST https://api.pirsch.io/api/v1/event

INFO

Fields with underscores are comments.

EXAMPLE REQUEST
JSON
{
    "event_name":       "Button Clicked",
    "_duration":        "event_duration is an optional number of seconds.",
    "event_duration":   42,
    "_metadata":        "event_meta is a single dimension object of scalar values (strings, numbers, and booleans).",
    "event_meta": {
        "key":             "value",
        "metadata fields": "are optional"
    },
    "_hit":                         "The fields below are the same as for hits.",
    "url":                          "https://example.com/full/url?including=parameters",
    "ip":                           "123.456.789.0",
    "dnt":                          "DNT header (optional)",
    "user_agent":                   "User-Agent header",
    "accept_language":              "Accept-Language header (optional)",
    "sec_ch_ua":                    "Sec-CH-UA header (optional)",
	"sec_ch_ua_mobile":             "Sec-CH-UA-Mobile header (optional)",
	"sec_ch_ua_platform":           "Sec-CH-UA-Platform header (optional)",
	"sec_ch_ua_platform_version":   "Sec-CH-UA-Platform-Version header (optional)",
	"sec_ch_width":                 "Sec-CH-Width header (optional)",
    "sec_ch_viewport_width":        "Sec-CH-Viewport-Width header (optional)",
    "title":                        "Page title (optional)",
    "referrer" :                    "Referer header (optional)",
    "screen_width":                 1920,
    "screen_height":                1080
}
{
    "event_name":       "Button Clicked",
    "_duration":        "event_duration is an optional number of seconds.",
    "event_duration":   42,
    "_metadata":        "event_meta is a single dimension object of scalar values (strings, numbers, and booleans).",
    "event_meta": {
        "key":             "value",
        "metadata fields": "are optional"
    },
    "_hit":                         "The fields below are the same as for hits.",
    "url":                          "https://example.com/full/url?including=parameters",
    "ip":                           "123.456.789.0",
    "dnt":                          "DNT header (optional)",
    "user_agent":                   "User-Agent header",
    "accept_language":              "Accept-Language header (optional)",
    "sec_ch_ua":                    "Sec-CH-UA header (optional)",
	"sec_ch_ua_mobile":             "Sec-CH-UA-Mobile header (optional)",
	"sec_ch_ua_platform":           "Sec-CH-UA-Platform header (optional)",
	"sec_ch_ua_platform_version":   "Sec-CH-UA-Platform-Version header (optional)",
	"sec_ch_width":                 "Sec-CH-Width header (optional)",
    "sec_ch_viewport_width":        "Sec-CH-Viewport-Width header (optional)",
    "title":                        "Page title (optional)",
    "referrer" :                    "Referer header (optional)",
    "screen_width":                 1920,
    "screen_height":                1080
}

It's possible to send multiple events at once. If you use the batch endpoint, make sure the events are in order or they throw off your statistics. This works well for sites that run on a single server where you can buffer events.

POST https://api.pirsch.io/api/v1/event/batch

EXAMPLE REQUEST
JSON
[
    {
        // Same parameters as for singe event, plus the time the request was made to your server.
        "time": "2023-01-02T14:15:32Z"
    },
    // ...
]
[
    {
        // Same parameters as for singe event, plus the time the request was made to your server.
        "time": "2023-01-02T14:15:32Z"
    },
    // ...
]

Keeping Sessions Alive ​

This endpoint is used to manually keep sessions alive. A session is normally reset if no request (hit or event) is sent within a 30 minute timeframe. This feature can be used to extend a session indefinitely. It's not recommended to use this for regular websites, but can be useful for tracking applications or other custom software.

POST https://api.pirsch.io/api/v1/session

EXAMPLE REQUEST
JSON
{
    "ip":                           "123.456.789.0",
    "dnt":                          "DNT header (optional)",
    "user_agent":                   "User-Agent header",
    "sec_ch_ua":                    "Sec-CH-UA header (optional)",
	"sec_ch_ua_mobile":             "Sec-CH-UA-Mobile header (optional)",
	"sec_ch_ua_platform":           "Sec-CH-UA-Platform header (optional)",
	"sec_ch_ua_platform_version":   "Sec-CH-UA-Platform-Version header (optional)",
	"sec_ch_width":                 "Sec-CH-Width header (optional)",
    "sec_ch_viewport_width":        "Sec-CH-Viewport-Width header (optional)"
}
{
    "ip":                           "123.456.789.0",
    "dnt":                          "DNT header (optional)",
    "user_agent":                   "User-Agent header",
    "sec_ch_ua":                    "Sec-CH-UA header (optional)",
	"sec_ch_ua_mobile":             "Sec-CH-UA-Mobile header (optional)",
	"sec_ch_ua_platform":           "Sec-CH-UA-Platform header (optional)",
	"sec_ch_ua_platform_version":   "Sec-CH-UA-Platform-Version header (optional)",
	"sec_ch_width":                 "Sec-CH-Width header (optional)",
    "sec_ch_viewport_width":        "Sec-CH-Viewport-Width header (optional)"
}

It's possible to send multiple requests at once. If you use the batch endpoint, make sure the updates are in order or they throw off your statistics. This works well for sites that run on a single server where you can buffer requests.

POST https://api.pirsch.io/api/v1/session/batch

EXAMPLE REQUEST
JSON
[
    {
        // Same parameters as for a singe update, plus the time the request was made to your server.
        "time": "2023-01-02T14:15:32Z"
    },
    // ...
]
[
    {
        // Same parameters as for a singe update, plus the time the request was made to your server.
        "time": "2023-01-02T14:15:32Z"
    },
    // ...
]

Statistics ​

The following endpoints can be used to read statistics from Pirsch. To receive data, you must set the filter. It is skipped in the sample requests for brevity.

Filter ​

The following list contains all possible filter options. Only the required fields need to be set when making a request. Set the fields using URL query parameters, such as ?from=2021-05-08&to=2021-05-15&language=en.

FILTER OPTIONS
ParameterRequiredExampleFormat/Description
idyesA5kgYzK14mThe domain ID. Use the list endpoint to get the domain ID for the client.
fromyes2021-05-08YYYY-MM-DD
toyes2021-05-15YYYY-MM-DD
tznoEurope/BerlinThe time zone. If not set, the default time zone for the dashboard is used.
startno600Queries data for the past seconds (10 minutes in this example). The date range filters is ignored if set. The maximum is one hour (3600 seconds).
scalenoweekThe scale to group results. Can either be day (default), week, month, or year.
pathno/homeThe page path.
entry_pathno/homeThe entry page path.
exit_pathno/yteThe exit page path.
patternno(?i)^\/path/[^\/]+$A regular expression to filter and group pages.
eventnoButton clickedThe name of an event to filter for.
event_meta_keynoClicksThe event meta key to filter for. This field is used to break down a single event.
meta_(key)nometa_key0=value0&meta_key1=value1The event metadata key and values to filter for. Multiple keys can be set by prefixing them using meta_ and appending them to the URL. Only events with all key-value pairs is returned.
languagenoenISO-639-1 language code, like en for English.
countrynojpISO-3166 Alpha-2 country code, like jp for Japan.
citynoLondonName of a city.
referrernohttps://referring-website.com/The referrer, usually a URL or name (note that the Pirsch dashboard does trim the protocol).
referrer_namenoreferring-website.comThe referrer name, usually the hostname.
osnoWindowsThe operating system.
browsernoFirefoxThe browser.
platformnodesktopThe platform, desktop, mobile, or unknown (not set).
screen_classnoXXLThe screen class, XXL, XL, L, M, S.
utm_sourcenoNewsletterThe UTM source.
utm_mediumnoEmailThe UTM medium.
utm_campaignnoSummer SaleThe UTM campaign.
utm_contentnoHeaderThe UTM content.
utm_termnosearch termsThe UTM term.
custom_metric_typenointegerThe custom metric type used to aggregate statistics. This will be used to parse the custom_metric_key event metadata key. It can be either float or integer.
custom_metric_keynointegerThe custom metric key used to aggregate statistics. This will be used to parse the an event metadata value. Used in combination with the custom_metric_type.
limitno20Limits the number of results, note that this is hard limited to 100.
include_avg_time_on_pagenotrueSet to true, to include the average time on page when reading page statistics.
sortnovisitorsSort results by given field. This is only available for pages, entry/exit pages, referrers, UTM statistics, conversion goals, events, demographics, and device statistics.
directionnodescSort results in ascending (asc) or descending (desc) order. This is only available for pages, entry/exit pages, referrers, UTM statistics, conversion goals, events, demographics, and device statistics.
searchno/homeSearch the primary field for given string (contains). For pages this is the path, for browsers the browser name, and so on. This is only available for pages, entry/exit pages, referrers, UTM statistics, conversion goals, events, demographics, and device statistics.

Filter Options ​

The following endpoints return available filtering options for a time period. For brevity, only one example request and response is given.

FILTER OPTIONS
GET /api/v1/statistics/options/referrer/name
GET /api/v1/statistics/options/page
GET /api/v1/statistics/options/referrer
GET /api/v1/statistics/options/event
GET /api/v1/statistics/options/country
GET /api/v1/statistics/options/city
GET /api/v1/statistics/options/language
GET /api/v1/statistics/options/metadata
GET /api/v1/statistics/options/utm/source
GET /api/v1/statistics/options/utm/medium
GET /api/v1/statistics/options/utm/campaign
GET /api/v1/statistics/options/utm/content
GET /api/v1/statistics/options/utm/term
GET /api/v1/statistics/options/referrer/name
GET /api/v1/statistics/options/page
GET /api/v1/statistics/options/referrer
GET /api/v1/statistics/options/event
GET /api/v1/statistics/options/country
GET /api/v1/statistics/options/city
GET /api/v1/statistics/options/language
GET /api/v1/statistics/options/metadata
GET /api/v1/statistics/options/utm/source
GET /api/v1/statistics/options/utm/medium
GET /api/v1/statistics/options/utm/campaign
GET /api/v1/statistics/options/utm/content
GET /api/v1/statistics/options/utm/term

It's possible to use an access code by setting the access query parameter.

GET /api/v1/statistics/options/page?id=A5kgYzK14m&from=2022-02-01&to=2022-03-27

EXAMPLE RESPONSE
JSON
[
    "/",
    "/some/path",
    "/other/path",
    // ...
]
[
    "/",
    "/some/path",
    "/other/path",
    // ...
]

Overview ​

This endpoint returns basic statistics and the number of members for given domain ID. The results are cached.

GET /api/v1/statistics/overview?id=A5kgYzK14m

EXAMPLE RESPONSE
JSON
{
    "visitors": 52,
    "views": 102,
    "visitor_growth": 0.02,
    "views_growth": 0.23,
    "member": 4
}
{
    "visitors": 52,
    "views": 102,
    "visitor_growth": 0.02,
    "views_growth": 0.23,
    "member": 4
}

Session Duration ​

GET /api/v1/statistics/duration/session

EXAMPLE RESPONSE

Which time component is set depends on the scale filter. Setting it to day (default) sets the day field. Otherwise the corresponding field will be set.

JSON
[
    {
        "day": "2021-05-12T00:00:00Z",
        "week": null,
        "month": null,
        "year": null,
        "average_time_spent_seconds": 42
    },
    // ...
]
[
    {
        "day": "2021-05-12T00:00:00Z",
        "week": null,
        "month": null,
        "year": null,
        "average_time_spent_seconds": 42
    },
    // ...
]

Time on Page ​

GET /api/v1/statistics/duration/page

EXAMPLE RESPONSE

Which time component is set depends on the scale filter. Setting it to day (default) sets the day field. Otherwise the corresponding field is set.

JSON
[
    {
        "day": "2021-05-12T00:00:00Z",
        "week": null,
        "month": null,
        "year": null,
        "path" "/home",
        "average_time_spent_seconds": 42
    },
    // ...
]
[
    {
        "day": "2021-05-12T00:00:00Z",
        "week": null,
        "month": null,
        "year": null,
        "path" "/home",
        "average_time_spent_seconds": 42
    },
    // ...
]

UTM Source ​

GET /api/v1/statistics/utm/source

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_source": "source"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_source": "source"
    },
    // ...
]

UTM Medium ​

GET /api/v1/statistics/utm/medium

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_medium": "medium"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_medium": "medium"
    },
    // ...
]

UTM Campaign ​

GET /api/v1/statistics/utm/campaign

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_campaign": "campaign"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_campaign": "campaign"
    },
    // ...
]

UTM Content ​

GET /api/v1/statistics/utm/content

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_content": "content"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_content": "content"
    },
    // ...
]

UTM Term ​

GET /api/v1/statistics/utm/term

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_term": "term"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.342,
        "utm_term": "term"
    },
    // ...
]

Total Visitors ​

This endpoint returns the total number of visitors, views, sessions, bounces, bounce rate, conversion rate, and custom metrics. The difference from the visitors endpoint (see below) is that the results are not grouped by day. Manually summing visitors for multiple days gives a different result because returning visitors are counted multiple times.

GET /api/v1/statistics/total

EXAMPLE RESPONSE
JSON
{
    "visitors": 42,
    "views": 56,
    "sessions": 48,
    "bounces": 23,
    "bounce_rate": 0.4791,
    "cr": 0.25,
	"custom_metric_avg": 42.1,
	"custom_metric_total": 598
}
{
    "visitors": 42,
    "views": 56,
    "sessions": 48,
    "bounces": 23,
    "bounce_rate": 0.4791,
    "cr": 0.25,
	"custom_metric_avg": 42.1,
	"custom_metric_total": 598
}

Total Visitors, Page Views, and Members ​

This endpoint returns the total number of visitors, page views, and team members. Responses are cached for up to 30 minutes.

GET /api/v1/statistics/overview

EXAMPLE RESPONSE
JSON
{
    "visitors": 42,
    "views": 56,
    "visitors_growth": 0.42,
    "views_growth": 0.57,
    "member": 7
}
{
    "visitors": 42,
    "views": 56,
    "visitors_growth": 0.42,
    "views_growth": 0.57,
    "member": 7
}

Visitors ​

GET /api/v1/statistics/visitor

EXAMPLE RESPONSE

Which time component is set depends on the scale filter. Setting it to day (default) sets the day field. Otherwise the corresponding field is set.

JSON
[
    {
        "day": "2021-05-12T00:00:00Z",
        "week": null,
        "month": null,
        "year": null,
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "bounce_rate": 0.4791,
        "cr": 0.25,
        "custom_metric_avg": 42.1,
        "custom_metric_total": 598
    },
    // ...
]
[
    {
        "day": "2021-05-12T00:00:00Z",
        "week": null,
        "month": null,
        "year": null,
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "bounce_rate": 0.4791,
        "cr": 0.25,
        "custom_metric_avg": 42.1,
        "custom_metric_total": 598
    },
    // ...
]

Pages ​

GET /api/v1/statistics/page

EXAMPLE RESPONSE
JSON
[
    {
        "path": "/home",
        "title": "Home",
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "relative_visitors": 0.342,
        "relative_views": 0.298,
        "bounce_rate": 0.765,
        "average_time_spent_seconds": 42
    },
    // ...
]
[
    {
        "path": "/home",
        "title": "Home",
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "relative_visitors": 0.342,
        "relative_views": 0.298,
        "bounce_rate": 0.765,
        "average_time_spent_seconds": 42
    },
    // ...
]

Entry Pages ​

GET /api/v1/statistics/page/entry

EXAMPLE RESPONSE
JSON
[
    {
        "path": "/home",
        "title": "Home",
        "visitors": 42,
        "sessions": 67,
        "entries": 56,
        "entry_rate": 0.298,
        "average_time_spent_seconds": 42
    },
    // ...
]
[
    {
        "path": "/home",
        "title": "Home",
        "visitors": 42,
        "sessions": 67,
        "entries": 56,
        "entry_rate": 0.298,
        "average_time_spent_seconds": 42
    },
    // ...
]

Exit Pages ​

GET /api/v1/statistics/page/exit

EXAMPLE RESPONSE
JSON
[
    {
        "path": "/bye",
        "title": "Bye",
        "visitors": 42,
        "sessions": 67,
        "exits": 56,
        "exit_rate": 0.298
    },
    // ...
]
[
    {
        "path": "/bye",
        "title": "Bye",
        "visitors": 42,
        "sessions": 67,
        "exits": 56,
        "exit_rate": 0.298
    },
    // ...
]

Event Pages ​

This endpoint returns all pages on which an event was triggered. It requires the event name filter to be set.

GET /api/v1/statistics/event/page

EXAMPLE RESPONSE
JSON
[
    {
        "path": "/home",
        "title": "Home",
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "relative_visitors": 0.342,
        "relative_views": 0.298,
        "bounce_rate": 0.765,
        "average_time_spent_seconds": 42
    },
    // ...
]
[
    {
        "path": "/home",
        "title": "Home",
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "relative_visitors": 0.342,
        "relative_views": 0.298,
        "bounce_rate": 0.765,
        "average_time_spent_seconds": 42
    },
    // ...
]

Conversion Goals ​

GET /api/v1/statistics/goals

EXAMPLE RESPONSE
JSON
[
    {
        "page_goal": {
            "id": "A5kgYzK14m",
            "def_time": "2021-05-22T10:11:12.123456Z",
            "mod_time": "2021-05-22T10:11:12.123456Z",
            "domain_id": "M03loiem34",
            "name": "My Conversion Goal",
            "path_pattern": "/path/**",
            "pattern": "(?i)^\/path/[^\/]+$",
            "event_name": "event",
            "event_meta_key": "currency",
            "event_meta_value": "USD",
            "custom_metric_key": "amount",
            "custom_metric_type": "float",
            "visitor_goal": 5432,
            "cr_goal": 42.11,
            "custom_metric_total_goal": 346,
	        "custom_metric_avg_goal": 95.3,
            "delete_reached": true,
            "email_reached": true
        }
        "stats": {
            "visitors": 432,
            "views": 563,
            "cr": 0.065
        }
    },
    // ...
]
[
    {
        "page_goal": {
            "id": "A5kgYzK14m",
            "def_time": "2021-05-22T10:11:12.123456Z",
            "mod_time": "2021-05-22T10:11:12.123456Z",
            "domain_id": "M03loiem34",
            "name": "My Conversion Goal",
            "path_pattern": "/path/**",
            "pattern": "(?i)^\/path/[^\/]+$",
            "event_name": "event",
            "event_meta_key": "currency",
            "event_meta_value": "USD",
            "custom_metric_key": "amount",
            "custom_metric_type": "float",
            "visitor_goal": 5432,
            "cr_goal": 42.11,
            "custom_metric_total_goal": 346,
	        "custom_metric_avg_goal": 95.3,
            "delete_reached": true,
            "email_reached": true
        }
        "stats": {
            "visitors": 432,
            "views": 563,
            "cr": 0.065
        }
    },
    // ...
]

pattern is the regex pattern stored for the conversion goal, which can be used as the pattern parameter in the filter. path_pattern is the path pattern as configured by the user in the dashboard. The pattern is generated from this.

path_pattern, pattern and any of the event/custom metric members are optional and null in case they're not set.

custom_metric_type can be either integer or float.

Events ​

This endpoint lists all events and their metadata keys. You can use the event metadata endpoint to get the values for the event and a key.

GET /api/v1/statistics/events

EXAMPLE RESPONSE
JSON
[
    {
        "name": "event name",
        "visitors": 432,
        "views": 563,
        "cr": 0.065,
        "average_duration_seconds": 42,
        "meta_keys": ["meta", "keys"]
    },
    // ...
]
[
    {
        "name": "event name",
        "visitors": 432,
        "views": 563,
        "cr": 0.065,
        "average_duration_seconds": 42,
        "meta_keys": ["meta", "keys"]
    },
    // ...
]

Event Metadata ​

This endpoint breaks down the event meta keys and values for a single event. You must filter for an event name and meta key in order for this to work.

GET /api/v1/statistics/event/meta

EXAMPLE RESPONSE
JSON
[
    {
        "name": "event name",
        "visitors": 432,
        "views": 563,
        "cr": 0.065,
        "average_duration_seconds": 42,
        "meta_value": "value",
    },
    // ...
]
[
    {
        "name": "event name",
        "visitors": 432,
        "views": 563,
        "cr": 0.065,
        "average_duration_seconds": 42,
        "meta_value": "value",
    },
    // ...
]

Listing Events ​

This endpoint lists all events, including metadata. Note that this can be an expensive operation if you select events without filtering. Events are grouped by name and metadata. We recommend filtering by path ("all events on this page") and optionally by metadata key-value pairs.

GET /api/v1/statistics/event/list

EXAMPLE RESPONSE
JSON
[
    {
        "name": "Read article",
        "meta": {
            "title": "How We Develop and Operate Pirsch"
        },
        "visitors": 123,
        "count": 237
    },
    {
        "name": "Read article",
        "meta": {
            "title": "How to Track the Reading Time of Blog Articles and Registrations"
        },
        "visitors": 98,
        "count": 105
    },
    // ...
]
[
    {
        "name": "Read article",
        "meta": {
            "title": "How We Develop and Operate Pirsch"
        },
        "visitors": 123,
        "count": 237
    },
    {
        "name": "Read article",
        "meta": {
            "title": "How to Track the Reading Time of Blog Articles and Registrations"
        },
        "visitors": 98,
        "count": 105
    },
    // ...
]

Growth Rates ​

GET /api/v1/statistics/growth

EXAMPLE RESPONSE
JSON
{
    "visitors_growth": 0.34,
    "views_growth": -0.05,
    "sessions_growth": 0.32,
    "bounces_growth": 0.65,
    "time_spent_growth": 0.45,
    "cr_growth": 0.22,
	"custom_metric_avg_growth": 0.09,
	"custom_metric_total_growth": 0.11
}
{
    "visitors_growth": 0.34,
    "views_growth": -0.05,
    "sessions_growth": 0.32,
    "bounces_growth": 0.65,
    "time_spent_growth": 0.45,
    "cr_growth": 0.22,
	"custom_metric_avg_growth": 0.09,
	"custom_metric_total_growth": 0.11
}

Active Visitors ​

Returns active visitors and pages for the past n seconds. n can be defined by passing the start query parameter and is set to 10 minutes by default.

Return the active visitors for the last minute.

GET /api/v1/statistics/active?start=60

EXAMPLE RESPONSE
JSON
{
    "stats": [
        {
            "path": "/home",
            "visitors": 42
        },
        // ...
    ],
    "visitors": 298
}
{
    "stats": [
        {
            "path": "/home",
            "visitors": 42
        },
        // ...
    ],
    "visitors": 298
}

Visitors by Time of Day ​

GET /api/v1/statistics/hours

EXAMPLE RESPONSE
JSON
[
    {
        "hour": 0,
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "bounce_rate": 0.4791,
        "cr": 0.25,
        "custom_metric_avg": 42.1,
        "custom_metric_total": 598
    },
    {
        "hour": 1,
        "visitors": 29,
        "views": 52,
        "sessions": 21,
        "bounces": 19,
        "bounce_rate": 0.3219,
        "cr": 0.25,
        "custom_metric_avg": 42.1,
        "custom_metric_total": 598
    },
    // ...
]
[
    {
        "hour": 0,
        "visitors": 42,
        "views": 56,
        "sessions": 48,
        "bounces": 23,
        "bounce_rate": 0.4791,
        "cr": 0.25,
        "custom_metric_avg": 42.1,
        "custom_metric_total": 598
    },
    {
        "hour": 1,
        "visitors": 29,
        "views": 52,
        "sessions": 21,
        "bounces": 19,
        "bounce_rate": 0.3219,
        "cr": 0.25,
        "custom_metric_avg": 42.1,
        "custom_metric_total": 598
    },
    // ...
]

Languages ​

GET /api/v1/statistics/language

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "language": "en"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "language": "en"
    },
    // ...
]

Referrer ​

GET /api/v1/statistics/referrer

EXAMPLE RESPONSE
JSON
[
    {
        "referrer": "Referrer",
        "referrer_name": "Name",
        "referrer_icon": "Icon",
        "visitors": 42,
        "sessions": 123,
        "relative_visitors": 0.256,
        "bounces": 21,
        "bounce_rate": 0.5
    },
    // ...
]
[
    {
        "referrer": "Referrer",
        "referrer_name": "Name",
        "referrer_icon": "Icon",
        "visitors": 42,
        "sessions": 123,
        "relative_visitors": 0.256,
        "bounces": 21,
        "bounce_rate": 0.5
    },
    // ...
]

Operating System ​

GET /api/v1/statistics/os

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "os": "Windows"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "os": "Windows"
    },
    // ...
]

Operating System Version ​

GET /api/v1/statistics/os

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "os": "Windows",
        "os_version": "10.0"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "os": "Windows",
        "os_version": "10.0"
    },
    // ...
]

Browser ​

GET /api/v1/statistics/browser

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "browser": "Firefox"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "browser": "Firefox"
    },
    // ...
]

Browser Version ​

GET /api/v1/statistics/browser/version

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "browser": "Firefox",
        "browser_version": "89.0"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "browser": "Firefox",
        "browser_version": "89.0"
    },
    // ...
]

Country ​

GET /api/v1/statistics/country

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "country": "jp"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "country": "jp"
    },
    // ...
]

City ​

GET /api/v1/statistics/city

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "city": "London"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "city": "London"
    },
    // ...
]

Platform ​

GET /api/v1/statistics/platform

EXAMPLE RESPONSE
JSON
{
    "platform_desktop": 457,
    "platform_mobile": 204,
    "platform_unknown": 98,
    "relative_platform_desktop": 0.56,
    "relative_platform_mobile": 0.34,
    "relative_platform_unknown": 0.17
}
{
    "platform_desktop": 457,
    "platform_mobile": 204,
    "platform_unknown": 98,
    "relative_platform_desktop": 0.56,
    "relative_platform_mobile": 0.34,
    "relative_platform_unknown": 0.17
}

Screen Classes ​

GET /api/v1/statistics/screen

EXAMPLE RESPONSE
JSON
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "screen_class": "XXL"
    },
    // ...
]
[
    {
        "visitors": 42,
        "relative_visitors": 0.24,
        "screen_class": "XXL"
    },
    // ...
]

Keywords ​

This endpoints requires the Google Search Console integration.

INFO

We recommend using the Search Console API directly instead of calling it through Pirsch.

GET /api/v1/statistics/keywords

EXAMPLE RESPONSE
JSON
[
    {
        "keys": ["key", "word"],
        "clicks": 456,
        "impressions": 920,
        "ctr": 0.49,
        "position": 4
    },
    // ...
]
[
    {
        "keys": ["key", "word"],
        "clicks": 456,
        "impressions": 920,
        "ctr": 0.49,
        "position": 4
    },
    // ...
]

Managing Domains ​

Domains can be managed by creating a user client (on the account settings page).

Getting the Domain ID ​

Most API endpoints require you to set a domain ID. We call them domains, but you can also think of them as a single dashboard. The terms are used interchangeably.

For clients created for a dashboard, only one domain is returned. For clients created on the account settings page, this endpoint returns all domains that you have access to.

Don't forget to set the access token or access key in the Authorization header: Bearer <oAuth access token or access key>.

GET /api/v1/domain

EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "user_id": "pzy1bjD1lv",
        "organization_id": null,
        "hostname": "example.com",
        "subdomain": "example",
        "identification_code": "oSdiAe...",
        "public": false,
        "google_user_id": null,
        "google_user_email": null,
        "gsc_domain": null,
        "new_owner": null,
        "timezone": "Europe/Berlin",
	    "group_by_title": false,
	    "active_visitors_seconds": 600,
        "disable_scripts": false,
        "statistics_start": null,
        "imported_statistics": false,
        "metadata": {},
        "theme_id": "x98y1bjAm72",
	    "theme": {
            // key value pairs
        },
        "custom_domain": "my.custom-domain.com",
        "user_role": "Owner", // Admin, Viewer
        "settings": {},
        "theme_settings": {
            // key value pairs
        }
    }
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "user_id": "pzy1bjD1lv",
        "organization_id": null,
        "hostname": "example.com",
        "subdomain": "example",
        "identification_code": "oSdiAe...",
        "public": false,
        "google_user_id": null,
        "google_user_email": null,
        "gsc_domain": null,
        "new_owner": null,
        "timezone": "Europe/Berlin",
	    "group_by_title": false,
	    "active_visitors_seconds": 600,
        "disable_scripts": false,
        "statistics_start": null,
        "imported_statistics": false,
        "metadata": {},
        "theme_id": "x98y1bjAm72",
	    "theme": {
            // key value pairs
        },
        "custom_domain": "my.custom-domain.com",
        "user_role": "Owner", // Admin, Viewer
        "settings": {},
        "theme_settings": {
            // key value pairs
        }
    }
]

Creating a Domain ​

This endpoint adds a new domain.

POST /api/v1/domain

EXAMPLE REQUEST
JSON
{
    "hostname": "example.com",
    "subdomain": "example",
    "timezone": "Europe/Berlin"
}
{
    "hostname": "example.com",
    "subdomain": "example",
    "timezone": "Europe/Berlin"
}
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "04jmfg0",
    "hostname": "example.com",
    "subdomain": "example",
    "identification_code": "...",
    "public": false,
    "google_user_id": null,
    "google_user_email": null,
    "gsc_domain": null,
    "new_owner": null,
    "timezone": "Europe/Berlin",
    "group_by_title": false,
    "user_role": "Owner",
    "active_visitors_seconds": 600,
    "disable_scripts": false,
    "statistics_start": null,
    "imported_statistics": false,
    "metadata": {
        // generic object
    },
    "settings": {
        // key value pairs
    }
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "04jmfg0",
    "hostname": "example.com",
    "subdomain": "example",
    "identification_code": "...",
    "public": false,
    "google_user_id": null,
    "google_user_email": null,
    "gsc_domain": null,
    "new_owner": null,
    "timezone": "Europe/Berlin",
    "group_by_title": false,
    "user_role": "Owner",
    "active_visitors_seconds": 600,
    "disable_scripts": false,
    "statistics_start": null,
    "imported_statistics": false,
    "metadata": {
        // generic object
    },
    "settings": {
        // key value pairs
    }
}

Deleting a Domain ​

This endpoint deletes a domain.

DELETE /api/v1/domain?id=A5kgYzK14m

Listing Domains ​

This endpoint is described in more detail in the Statistics section. It returns all domains for a user client or a specific domain for the ID, subdomain, custom domain, or access code.

GET /api/v1/domain?id=A5kgYzK14m
GET /api/v1/domain?subdomain=example
GET /api/v1/domain?domain=my-domain.com
GET /api/v1/domain?access=03kDM6o...
GET /api/v1/domain?id=A5kgYzK14m
GET /api/v1/domain?subdomain=example
GET /api/v1/domain?domain=my-domain.com
GET /api/v1/domain?access=03kDM6o...
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "04jmfg0",
    "organization_id": "0do3kD3",
    "hostname": "example.com",
    "subdomain": "example",
    "identification_code": "...",
    "public": false,
    "google_user_id": null,
    "google_user_email": null,
    "gsc_domain": null,
    "new_owner": null,
    "timezone": "Europe/Berlin",
    "group_by_title": false,
    "active_visitors_seconds": 600,
    "disable_scripts": false,
    "statistics_start": null,
    "imported_statistics": false,
    "metadata": {
        // generic object
    },
    "theme_id": null,
    "theme": {
        // key value pairs
    },
    "custom_domain": "my-domain.com",
    "user_role": "Owner",
    "settings": {
        // key value pairs
    },
    "theme_settings": {
        // key value pairs applied to the dashboard
    }
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "04jmfg0",
    "organization_id": "0do3kD3",
    "hostname": "example.com",
    "subdomain": "example",
    "identification_code": "...",
    "public": false,
    "google_user_id": null,
    "google_user_email": null,
    "gsc_domain": null,
    "new_owner": null,
    "timezone": "Europe/Berlin",
    "group_by_title": false,
    "active_visitors_seconds": 600,
    "disable_scripts": false,
    "statistics_start": null,
    "imported_statistics": false,
    "metadata": {
        // generic object
    },
    "theme_id": null,
    "theme": {
        // key value pairs
    },
    "custom_domain": "my-domain.com",
    "user_role": "Owner",
    "settings": {
        // key value pairs
    },
    "theme_settings": {
        // key value pairs applied to the dashboard
    }
}

Resetting the Identification Code ​

This endpoint resets the identification code for the domain and return a new one.

PUT /api/v1/domain

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m"
}
{
    "id": "A5kgYzK14m"
}
EXAMPLE RESPONSE
JSON
{
    "identification_code": "..."
}
{
    "identification_code": "..."
}

Updating the Hostname ​

This endpoint updates the hostname for your domain.

POST /api/v1/domain/hostname

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "hostname": "new-hostname.com"
}
{
    "domain_id": "A5kgYzK14m",
    "hostname": "new-hostname.com"
}

Updating the Subdomain ​

This endpoint updates the subdomain for your dashboard (on your-sub-domain.pirsch.io).

POST /api/v1/domain/subdomain

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "subdomain": "new-subdomain"
}
{
    "domain_id": "A5kgYzK14m",
    "subdomain": "new-subdomain"
}

Toggle the Visiblity of Your Dashboard ​

This endpoint toggles the visibility of your dashboard from private to public or vice versa.

POST /api/v1/domain/public

EXAMPLE RESPONSE
JSON
{
    "domain_id": "A5kgYzK14m"
}
{
    "domain_id": "A5kgYzK14m"
}

Disable Scripts ​

This endpoint toggles the option to send data via scripts for a given domain.

POST /api/v1/domain/scripts

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m"
}
{
    "domain_id": "A5kgYzK14m"
}

Toggle Grouping by Title ​

This endpoint toggles if statistics are grouped by page title.

POST /api/v1/domain/title

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m"
}
{
    "domain_id": "A5kgYzK14m"
}

Changing the Active Visitors Time ​

This endpoint changes the time in seconds that visitors are considered active on your site.

POST /api/v1/domain/active

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "time": 123
}
{
    "domain_id": "A5kgYzK14m",
    "time": 123
}

Changing the Time Zone ​

This endpoint changes the time zone for the dashboard.

POST /api/v1/domain/timezone

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "timezone": "Europe/Berlin"
}
{
    "domain_id": "A5kgYzK14m",
    "timezone": "Europe/Berlin"
}

Updating the metadata field. ​

This endpoint will update the metadata field. The field can be used to store user defined tags or configuration. Do what you want with it.

POST /api/v1/domain/metadata

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "metadata": {
        // generic object
    }
}
{
    "domain_id": "A5kgYzK14m",
    "metadata": {
        // generic object
    }
}

Setting a Domain as Favorite ​

This endpoint sets one of your domains as a favorite. This requires a user client.

POST /api/v1/user/favorite

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m"
}
{
    "id": "A5kgYzK14m"
}

Showing Active Visitors in the Page Title ​

This endpoint toggles whether or not to display active visitors in the page title (tab).

POST /api/v1/user/active

Toggle Full Width ​

This endpoint toggles displaying the dashboard at full width.

POST /api/v1/user/fullwidth

This endpoint lists all access links.

GET /api/v1/domain/link?domain_id=A5kgYzK14m

EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "A5kgYzK14m",
        "code": "...",
        "description": "..."
    },
    // ...
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "A5kgYzK14m",
        "code": "...",
        "description": "..."
    },
    // ...
]

The code can be used to create a URL with read-only access to a domain. To do that, replace <subdomain> and <code for the domain in the following URL: https://<subdomain>.pirsch.io/?access=<code>

Set Base Theme ​

This endpoint sets the base theme for a dashboard. The settings from the theme will be overwritten by specific settings for the dashboard.

PUT /api/v1/domain/theme

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "theme_id": "83MD02kxoe"
}
{
    "domain_id": "A5kgYzK14m",
    "theme_id": "83MD02kxoe"
}
EXAMPLE RESPONSE
JSON
{
    // key value pairs with the theme settings
}
{
    // key value pairs with the theme settings
}

Update the Theme Settings ​

This endpoint updates the theme settings for given domain. The settings will overwrite the base theme.

POST /api/v1/domain/theme

EXAMPLE REQUEST
FormData:

logo_light: File
logo_dark: File
favicon: File
data: JSON {
    "domain_id": "A5kgYzK14m",
    "settings": {
        // key value pairs
    }
}
FormData:

logo_light: File
logo_dark: File
favicon: File
data: JSON {
    "domain_id": "A5kgYzK14m",
    "settings": {
        // key value pairs
    }
}
EXAMPLE RESPONSE
JSON
{
    // complete domain with the updated settings
}
{
    // complete domain with the updated settings
}

Set a Custom Domain ​

This endpoint updates the custom domain for given dashboard.

POST /api/v1/domain/custom

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "hostname": "my-domain.com"
}
{
    "domain_id": "A5kgYzK14m",
    "hostname": "my-domain.com"
}

Check Whether a Custom Domain Exists ​

This endpoint checks whether a custom domain exists already. A custom domain can only be used for a single dashboard.

GET /api/v1/domain/custom?domain=my-domain.com

This endpoint creates a new access link.

POST /api/v1/domain/link

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "description": "..."
}
{
    "domain_id": "A5kgYzK14m",
    "description": "..."
}
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
    "code": "...",
    "description": "..."
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
    "code": "...",
    "description": "..."
}

This endpoint updates an existing access link.

PUT /api/v1/domain/link

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m",
    "description": "..."
}
{
    "id": "A5kgYzK14m",
    "description": "..."
}

This endpoint deletes an access link.

DELETE /api/v1/domain/link?id=0DJ0mo934

Managing Members and Permissions ​

Listing Members ​

This endpoint lists all members for a domain or an organization.

GET /api/v1/member?id=A5kgYzK14m
GET /api/v1/member?organization_id=kco39ID2
GET /api/v1/member?id=A5kgYzK14m
GET /api/v1/member?organization_id=kco39ID2
EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "user_id": "pzy1bjD1lv",
        "domain_id": "A5kgYzK14m",
        "organization_id": "kco39ID2",
        "role": "admin",
        "user": {
            "id": "0DJ0mo934",
            "email": "...",
            "full_name": "...",
            "picture": "..."
        }
    },
    // ...
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "user_id": "pzy1bjD1lv",
        "domain_id": "A5kgYzK14m",
        "organization_id": "kco39ID2",
        "role": "admin",
        "user": {
            "id": "0DJ0mo934",
            "email": "...",
            "full_name": "...",
            "picture": "..."
        }
    },
    // ...
]

Inviting Members ​

This endpoint invites new members to a domain or an organization via email. New members have the Viewer role. They'll receive an account activation if they don't have an account yet.

POST /api/v1/member

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m",
    "organization_id": null,
    "emails": ["member@foo.com", "member@bar.com" /* ... */]
}
{
    "id": "A5kgYzK14m",
    "organization_id": null,
    "emails": ["member@foo.com", "member@bar.com" /* ... */]
}

id is the domain ID. Either the id or organization_id must be set.

Updating the Role of a Member ​

This endpoint updates a single member's role. Valid roles are Viewer and Admin (the Owner role requires a domain transfer). This works for domains and organizations.

PUT /api/v1/member

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m",
    "role": "admin"
}
{
    "id": "A5kgYzK14m",
    "role": "admin"
}

id is the member ID.

Removing a Member ​

This endpoint removes a member from a domain or an organization.

DELETE /api/v1/member?id=0DJ0mo934

Listing Invitations ​

This endpoint lists all invitations for the user, a domain, or an organization.

GET /api/v1/invitation
GET /api/v1/invitation?domain_id=A5kgYzK14m
GET /api/v1/invitation?organization_id=39oOw9mKD31
GET /api/v1/invitation
GET /api/v1/invitation?domain_id=A5kgYzK14m
GET /api/v1/invitation?organization_id=39oOw9mKD31
EXAMPLE RESPONSE
JSON
[
    {
        "id": "I309Dow31",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "A5kgYzK14m",
        "organization_id": null,
        "email": "user@example.com",
        "domain": {
            // complete domain
        },
        "organization": null // or complete organization if ID is set
    },
    // ...
]
[
    {
        "id": "I309Dow31",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "A5kgYzK14m",
        "organization_id": null,
        "email": "user@example.com",
        "domain": {
            // complete domain
        },
        "organization": null // or complete organization if ID is set
    },
    // ...
]

Deleting an Invitation ​

This endpoint deletes an invitation to a domain or an organization.

DELETE /api/v1/invitation

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "organization_id": null,
    "id": "I309Dow31"
}
{
    "domain_id": "A5kgYzK14m",
    "organization_id": null,
    "id": "I309Dow31"
}

domain_id and organization_id are optional. They are used to look up the invitationf or a domain or an organization instead of the currently signed in user.

Accepting an Invitation ​

This endpoint will accept an invitation for the currently signed in user.

POST /api/v1/invitation

EXAMPLE REQUEST
JSON
{
    "id": "I309Dow31"
}
{
    "id": "I309Dow31"
}

Managing Alternative Domains ​

Alternative domains allow you to add additional traffic sources. By default, Pirsch will block a request that doesn't come from the domain configured on the dashboard. For example, if you want to create a roll-up view, you will need to add any domain that could send traffic to the dashboard as an additional domain.

Always add the domain alternatives at the receiving end.

Listing Alternative Domains ​

This endpoint returns all alternative domains associated with a website.

GET /api/v1/domain/alternative?domain_id=0DJ0mo934

EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "hostname": "alternative.domain.com"
    },
    // ...
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "hostname": "alternative.domain.com"
    },
    // ...
]

Creating Alternative Domains ​

This endpoint creates a new alternate domain for a Website.

POST /api/v1/domain/alternative

EXAMPLE REQUEST
JSON
{
    "domain_id": "0DJ0mo934",
    "hostname": "alternative.domain.com"
}
{
    "domain_id": "0DJ0mo934",
    "hostname": "alternative.domain.com"
}
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "hostname": "alternative.domain.com"
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "hostname": "alternative.domain.com"
}

Updating Alternative Domains ​

This endpoint updates the hostname for an alternative domain.

PUT /api/v1/domain/alternative

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m",
    "hostname": "new-alternative.domain.com"
}
{
    "id": "A5kgYzK14m",
    "hostname": "new-alternative.domain.com"
}

Deleting Alternative Domains ​

This endpoint deletes an alternative domain by ID.

DELETE /api/v1/domain/alternative?id=A5kgYzK14m

Managing snippets ​

The snippets can be customized for advanced usage. There are two snippet configurations: page view and event.

Updating a Snippet ​

This endpoint updates a snippet for a domain and type. The type can either be page view or event.

POST /api/v1/domain/snippet

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "type": "page view",
	"dev": true,
	"include": "\/include,\/path\/.*",
	"exclude": "\/exclude,\/path\/.*",
	"domains": "example.com,domain.com",
	"endpoint": "https://pirsch.proxy.com/hit",
	"sample": "/sample,/paths"
}
{
    "domain_id": "A5kgYzK14m",
    "type": "page view",
	"dev": true,
	"include": "\/include,\/path\/.*",
	"exclude": "\/exclude,\/path\/.*",
	"domains": "example.com,domain.com",
	"endpoint": "https://pirsch.proxy.com/hit",
	"sample": "/sample,/paths"
}

Getting a Snippet ​

This endpoint returns the snippet details for a domain and type. The type can be either page view, event, or session.

GET /api/v1/domain/snippet?domain_id=A5kgYzK14m&type=event

EXAMPLE RESPONSE
JSON
{
    "id": "9do3JD31z",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
    "type": "event",
	"dev": true,
	"include": "\/include,\/path\/.*",
	"exclude": "\/exclude,\/path\/.*",
	"domains": "example.com,domain.com",
	"endpoint": "https://pirsch.proxy.com/hit",
	"sample": "/sample,/paths"
}
{
    "id": "9do3JD31z",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
    "type": "event",
	"dev": true,
	"include": "\/include,\/path\/.*",
	"exclude": "\/exclude,\/path\/.*",
	"domains": "example.com,domain.com",
	"endpoint": "https://pirsch.proxy.com/hit",
	"sample": "/sample,/paths"
}

Managing Clients ​

It's possible to manage domain clients with a user client.

Listing Clients ​

This endpoint lists all clients.

GET /api/v1/client?id=0DJ0mo934

EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "client_id": "...", // 32 characters
        "description": "...",
        "scope_hit": "w",
        "scope_event": "w",
        "scope_session": "w",
        "scope_statistics": "r",
        "scope_domains": "w"
    },
    // ...
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "client_id": "...", // 32 characters
        "description": "...",
        "scope_hit": "w",
        "scope_event": "w",
        "scope_session": "w",
        "scope_statistics": "r",
        "scope_domains": "w"
    },
    // ...
]

Creating a Client ​

This endpoint creates a new client.

POST /api/v1/client

EXAMPLE REQUEST
JSON
{
    "domain_id": "0DJ0mo934",
    "type": "token",
    "description": "...",
    "scope_hit": "w",
    "scope_event": "w",
    "scope_session": "w",
    "scope_statistics": "r",
    "scope_domains": "w"
}
{
    "domain_id": "0DJ0mo934",
    "type": "token",
    "description": "...",
    "scope_hit": "w",
    "scope_event": "w",
    "scope_session": "w",
    "scope_statistics": "r",
    "scope_domains": "w"
}

The type can either be oauth or token. oauth will create an oAuth client with a client ID and secret that can be used to read and write data. The token type is read-only and typically used to send statistics.

Scopes can grant read or write access. The table below shows the possible values for available scopes.

ScopeReadWrite
hitx
eventx
statisticsx
domainsxx

The domains scope has two different meanings, depending on whether it's used for a domain or a user client:

  • For user clients, it provides access to most user actions, such as creating or deleting domains and settings.
  • For domain clients, it provides access to domain-specific settings, such as the subdomain or access links.
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "client_id": "...", // 32 characters
    "client_secret": "...", // 64 characters
    "description": "...",
    "scope_hit": "w",
    "scope_event": "w",
    "scope_session": "w",
    "scope_statistics": "r",
    "scope_domains": "w"
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "client_id": "...", // 32 characters
    "client_secret": "...", // 64 characters
    "description": "...",
    "scope_hit": "w",
    "scope_event": "w",
    "scope_session": "w",
    "scope_statistics": "r",
    "scope_domains": "w"
}

Updating a Client ​

This endpoint updates the description for a client.

POST /api/v1/client

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m",
    "description": "..."
}
{
    "id": "A5kgYzK14m",
    "description": "..."
}
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "client_id": "...", // 32 characters
    "description": "...",
    "scope_hit": "w",
    "scope_event": "w",
    "scope_session": "w",
    "scope_statistics": "r",
    "scope_domains": "w"
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "client_id": "...", // 32 characters
    "description": "...",
    "scope_hit": "w",
    "scope_event": "w",
    "scope_session": "w",
    "scope_statistics": "r",
    "scope_domains": "w"
}

Deleting a Client ​

This endpoint deletes a client.

DELETE /api/v1/client?id=A5kgYzK14m

Managing Email Reports ​

Listing Email Reports ​

This endpoint lists all email reports.

GET /api/v1/report?id=0DJ0mo934

EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "email": "...",
        "interval": 2,
        "next_report": "2021-05-22T10:11:12.123456Z"
    },
    // ...
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "email": "...",
        "interval": 2,
        "next_report": "2021-05-22T10:11:12.123456Z"
    },
    // ...
]

Creating Email Reports ​

This endpoint creates a new email report.

POST /api/v1/report

EXAMPLE REQUEST
JSON
{
    "domain_id": "0DJ0mo934",
    "emails": ["member@foo.com", "member@bar.com"],
    "interval": 1 // weeks
}
{
    "domain_id": "0DJ0mo934",
    "emails": ["member@foo.com", "member@bar.com"],
    "interval": 1 // weeks
}
EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "email": "...",
        "interval": 1,
        "next_report": "2021-05-22T10:11:12.123456Z"
    },
    // ...
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "email": "...",
        "interval": 1,
        "next_report": "2021-05-22T10:11:12.123456Z"
    },
    // ...
]

Updating an Email Report ​

This endpoint updates an existing email report.

PUT /api/v1/report

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m",
    "interval": 4 // weeks
}
{
    "id": "A5kgYzK14m",
    "interval": 4 // weeks
}
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "email": "...",
    "interval": 4,
    "next_report": "2021-05-22T10:11:12.123456Z"
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "email": "...",
    "interval": 4,
    "next_report": "2021-05-22T10:11:12.123456Z"
}

Deleting an Email Report ​

This endpoint deletes an email report.

DELETE /api/v1/report?id=A5kgYzK14m

Managing Conversion Goals ​

Listing Conversion Goals ​

This endpoint lists all conversion goals.

GET /api/v1/goal?id=0DJ0mo934

EXAMPLE RESPONSE
JSON
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "name": "...",
        "path_pattern": "...", // regex, null if not set
        "pattern": "/checkout/**", // or null if not set
        "event_name": "event", // or null if not set
        "event_meta_key": "currency", // or null if not set
        "event_meta_value": "USD", // or null if not set
        "custom_metric_key": "amount", // or null if not set
        "custom_metric_type": "float", // integer, float, or null if not set
        "visitor_goal": 123, // or null if not set
        "cr_goal": 1.23, // or null if not set
        "custom_metric_total_goal": 346, // or null if not set
        "custom_metric_avg_goal": 95.3, // or null if not set
        "delete_reached": false,
        "email_reached": true
    },
    // ...
]
[
    {
        "id": "A5kgYzK14m",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "0DJ0mo934",
        "name": "...",
        "path_pattern": "...", // regex, null if not set
        "pattern": "/checkout/**", // or null if not set
        "event_name": "event", // or null if not set
        "event_meta_key": "currency", // or null if not set
        "event_meta_value": "USD", // or null if not set
        "custom_metric_key": "amount", // or null if not set
        "custom_metric_type": "float", // integer, float, or null if not set
        "visitor_goal": 123, // or null if not set
        "cr_goal": 1.23, // or null if not set
        "custom_metric_total_goal": 346, // or null if not set
        "custom_metric_avg_goal": 95.3, // or null if not set
        "delete_reached": false,
        "email_reached": true
    },
    // ...
]

Creating a Conversion Goal ​

This endpoint creates a new conversion goal.

POST /api/v1/goal

Either the path_pattern and/or event fields must be set.

EXAMPLE REQUEST
JSON
{
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "/checkout/**", // or null
    "event_name": "event", // or null
    "event_meta_key": "currency", // or null
    "event_meta_value": "USD", // or null
    "custom_metric_key": "amount", // or null
    "custom_metric_type": "float", // integer, float, or null
    "visitors": 123, // 0 to pass
    "cr": 1.23, // 0 to pass
    "custom_metric_total_goal": 346, // 0 to pass
    "custom_metric_avg_goal": 95.3, // 0 to pass
    "delete_reached": false,
    "email_reached": true
}
{
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "/checkout/**", // or null
    "event_name": "event", // or null
    "event_meta_key": "currency", // or null
    "event_meta_value": "USD", // or null
    "custom_metric_key": "amount", // or null
    "custom_metric_type": "float", // integer, float, or null
    "visitors": 123, // 0 to pass
    "cr": 1.23, // 0 to pass
    "custom_metric_total_goal": 346, // 0 to pass
    "custom_metric_avg_goal": 95.3, // 0 to pass
    "delete_reached": false,
    "email_reached": true
}
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "...", // regex or null if not set
    "pattern": "/checkout/**", // or null if not set
    "event_name": "event", // or null if not set
    "event_meta_key": "currency", // or null if not set
    "event_meta_value": "USD", // or null if not set
    "custom_metric_key": "amount", // or null if not set
    "custom_metric_type": "float", // integer, float, or null
    "visitor_goal": 123, // or null if not set
    "cr_goal": 1.23, // or null if not set
    "custom_metric_total_goal": 346, // or null if not set
    "custom_metric_avg_goal": 95.3, // or null if not set
    "delete_reached": false,
    "email_reached": true
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "...", // regex or null if not set
    "pattern": "/checkout/**", // or null if not set
    "event_name": "event", // or null if not set
    "event_meta_key": "currency", // or null if not set
    "event_meta_value": "USD", // or null if not set
    "custom_metric_key": "amount", // or null if not set
    "custom_metric_type": "float", // integer, float, or null
    "visitor_goal": 123, // or null if not set
    "cr_goal": 1.23, // or null if not set
    "custom_metric_total_goal": 346, // or null if not set
    "custom_metric_avg_goal": 95.3, // or null if not set
    "delete_reached": false,
    "email_reached": true
}

Updating a Conversion Goal ​

This endpoint updates an existing converion goal.

PUT /api/v1/goal

EXAMPLE REQUEST
JSON
{
    "id": "A5kgYzK14m",
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "/checkout/**", // or null
    "event_name": "event", // or null
    "event_meta_key": "currency", // or null
    "event_meta_value": "USD", // or null
    "custom_metric_key": "amount", // or null
    "custom_metric_type": "float", // integer, float, or null
    "visitors": 123, // 0 to pass
    "cr": 1.23, // 0 to pass
    "custom_metric_total_goal": 346, // 0 to pass
    "custom_metric_avg_goal": 95.3, // 0 to pass
    "delete_reached": false,
    "email_reached": true
}
{
    "id": "A5kgYzK14m",
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "/checkout/**", // or null
    "event_name": "event", // or null
    "event_meta_key": "currency", // or null
    "event_meta_value": "USD", // or null
    "custom_metric_key": "amount", // or null
    "custom_metric_type": "float", // integer, float, or null
    "visitors": 123, // 0 to pass
    "cr": 1.23, // 0 to pass
    "custom_metric_total_goal": 346, // 0 to pass
    "custom_metric_avg_goal": 95.3, // 0 to pass
    "delete_reached": false,
    "email_reached": true
}
EXAMPLE RESPONSE
JSON
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "...", // regex or null if not set
    "pattern": "/checkout/**", // or null if not set
    "event_name": "event", // or null if not set
    "event_meta_key": "currency", // or null if not set
    "event_meta_value": "USD", // or null if not set
    "custom_metric_key": "amount", // or null if not set
    "custom_metric_type": "float", // integer, float, or null
    "visitor_goal": 123, // or null if not set
    "cr_goal": 1.23, // or null if not set
    "custom_metric_total_goal": 346, // or null if not set
    "custom_metric_avg_goal": 95.3, // or null if not set
    "delete_reached": false,
    "email_reached": true
}
{
    "id": "A5kgYzK14m",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "0DJ0mo934",
    "name": "...",
    "path_pattern": "...", // regex or null if not set
    "pattern": "/checkout/**", // or null if not set
    "event_name": "event", // or null if not set
    "event_meta_key": "currency", // or null if not set
    "event_meta_value": "USD", // or null if not set
    "custom_metric_key": "amount", // or null if not set
    "custom_metric_type": "float", // integer, float, or null
    "visitor_goal": 123, // or null if not set
    "cr_goal": 1.23, // or null if not set
    "custom_metric_total_goal": 346, // or null if not set
    "custom_metric_avg_goal": 95.3, // or null if not set
    "delete_reached": false,
    "email_reached": true
}

Deleting a Conversion Goal ​

This endpoint deletes a conversion goal.

DELETE /api/v1/goal?id=A5kgYzK14m

Testing the Regular Expression for a Conversion Goal ​

This endpoint tests whether a regular expression is valid for a conversion goal. Use it to see if you can use an expression before creating or updating a conversion goal.

POST /api/v1/goal/regex

EXAMPLE REQUEST
JSON
{
    "regex": "(?i)^/regular/expression/[^/]*$",
    "sample": "/regular/expression/example"
}
{
    "regex": "(?i)^/regular/expression/[^/]*$",
    "sample": "/regular/expression/example"
}
EXAMPLE RESPONSE
JSON
{
    "match": true
}
{
    "match": true
}

An error is returned if the expression is invalid. Otherwise, it returns if the regular expression matches the pattern.

Managing Views ​

Listing Views ​

This endpoint returns a list of views for a given domain.

GET /api/v1/view?domain_id=A5kgYzK14m

EXAMPLE RESPONSE
JSON
[
    {
        "id": "Jk49fgm38",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "A5kgYzK14m",
        "user_id": "94jO3jDM2",
        "name": "My View",
        "from": "2022-01-02",
        "to": "2022-03-04",
        "period": 5,
        "path": ["/sample/path"],
        "entry_path": null,
        "exit_path": null,
        "path_pattern": null,
        "pattern": null,
        "language": null,
        "country": null,
        "city": null,
        "referrer": null,
        "referrer_name": null,
        "os": null,
        "browser": null,
        "platform": null,
        "screen_class": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_content": null,
        "utm_term": null,
        "event": null,
        "event_meta_key": null,
        "event_meta_value": null,
    },
    // ...
]
[
    {
        "id": "Jk49fgm38",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "domain_id": "A5kgYzK14m",
        "user_id": "94jO3jDM2",
        "name": "My View",
        "from": "2022-01-02",
        "to": "2022-03-04",
        "period": 5,
        "path": ["/sample/path"],
        "entry_path": null,
        "exit_path": null,
        "path_pattern": null,
        "pattern": null,
        "language": null,
        "country": null,
        "city": null,
        "referrer": null,
        "referrer_name": null,
        "os": null,
        "browser": null,
        "platform": null,
        "screen_class": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_content": null,
        "utm_term": null,
        "event": null,
        "event_meta_key": null,
        "event_meta_value": null,
    },
    // ...
]

Creating/Updating a View ​

This endpoint creates a new view or updates an existing view. It updates an existing view if the ID is set.

POST /api/v1/view

EXAMPLE REQUEST
JSON
{
    "id": "Jk49fgm38",
    "domain_id": "A5kgYzK14m",
    "name": "My View",
    "public": true,
    "overwrite": true,
    "from": "2022-01-02",
    "to": "2022-03-04",
    "period": 5,
    "path": ["/sample/path"],
    "entry_path": null,
    "exit_path": null,
    "path_pattern": null,
    "pattern": null,
    "language": null,
    "country": null,
    "city": null,
    "referrer": null,
    "referrer_name": null,
    "os": null,
    "browser": null,
    "platform": null,
    "screen_class": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_content": null,
    "utm_term": null,
    "event": null,
    "event_meta_key": null,
    "event_meta_value": null,
}
{
    "id": "Jk49fgm38",
    "domain_id": "A5kgYzK14m",
    "name": "My View",
    "public": true,
    "overwrite": true,
    "from": "2022-01-02",
    "to": "2022-03-04",
    "period": 5,
    "path": ["/sample/path"],
    "entry_path": null,
    "exit_path": null,
    "path_pattern": null,
    "pattern": null,
    "language": null,
    "country": null,
    "city": null,
    "referrer": null,
    "referrer_name": null,
    "os": null,
    "browser": null,
    "platform": null,
    "screen_class": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_content": null,
    "utm_term": null,
    "event": null,
    "event_meta_key": null,
    "event_meta_value": null,
}
EXAMPLE RESPONSE
JSON
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
    "user_id": "94jO3jDM2",
    "name": "My View",
    "from": "2022-01-02",
    "to": "2022-03-04",
    "period": 5,
    "path": ["/sample/path"],
    "entry_path": null,
    "exit_path": null,
    "path_pattern": null,
    "pattern": null,
    "language": null,
    "country": null,
    "city": null,
    "referrer": null,
    "referrer_name": null,
    "os": null,
    "browser": null,
    "platform": null,
    "screen_class": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_content": null,
    "utm_term": null,
    "event": null,
    "event_meta_key": null,
    "event_meta_value": null,
}
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
    "user_id": "94jO3jDM2",
    "name": "My View",
    "from": "2022-01-02",
    "to": "2022-03-04",
    "period": 5,
    "path": ["/sample/path"],
    "entry_path": null,
    "exit_path": null,
    "path_pattern": null,
    "pattern": null,
    "language": null,
    "country": null,
    "city": null,
    "referrer": null,
    "referrer_name": null,
    "os": null,
    "browser": null,
    "platform": null,
    "screen_class": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_content": null,
    "utm_term": null,
    "event": null,
    "event_meta_key": null,
    "event_meta_value": null,
}

Deleting a View ​

This endpoint deletes a view.

DELETE /api/v1/view?id=Jk49fgm38

Managing Organizations ​

Listing Organizations ​

This endpoint lists all organizations the user belongs to or is the owner of.

GET /api/v1/organization

EXAMPLE RESPONSE
JSON
[
    {
        "id": "Jk49fgm38",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "user_id": "oOD28xa97",
        "name": "Organization",
        "member": 4,
        "domains": 5,
        "themes": 6,
        "role": "Owner",
        "can_edit": true
    },
    // ...
]
[
    {
        "id": "Jk49fgm38",
        "def_time": "2021-05-22T10:11:12.123456Z",
        "mod_time": "2021-05-22T10:11:12.123456Z",
        "user_id": "oOD28xa97",
        "name": "Organization",
        "member": 4,
        "domains": 5,
        "themes": 6,
        "role": "Owner",
        "can_edit": true
    },
    // ...
]

Can edit will be set to true if a Pirsch Plus subscription is active and the current user is the owner of the organization.

Creating an Organization ​

This endpoint creates a new organization.

POST /api/v1/organization

EXAMPLE REQUEST
JSON
{
    "name": "Organization"
}
{
    "name": "Organization"
}
EXAMPLE RESPONSE
JSON
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "oOD28xa97",
    "name": "Organization",
    "member": 4,
    "role": "Owner",
    "can_edit": true
}
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "oOD28xa97",
    "name": "Organization",
    "member": 4,
    "role": "Owner",
    "can_edit": true
}

Updating an Organization ​

This endpoint updates an existing organization.

PUT /api/v1/organization

EXAMPLE REQUEST
JSON
{
    "id": "Jk49fgm38",
    "name": "New Name"
}
{
    "id": "Jk49fgm38",
    "name": "New Name"
}
EXAMPLE RESPONSE
JSON
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "oOD28xa97",
    "name": "New Name",
    "member": 4,
    "role": "Owner",
    "can_edit": true
}
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "oOD28xa97",
    "name": "New Name",
    "member": 4,
    "role": "Owner",
    "can_edit": true
}

Deleting an Organization ​

This endpoint deletes an organization. If delete_domains is set to true, all domains belonging to this organization will also be deleted! Otherwise they will be removed from the organization.

DELETE /api/v1/organization?id=Jk49fgm38&delete_domains=true

Setting a Default Theme ​

This endpoint will set the default theme for given organization. The default theme is pre-selected when new websites are added to the organization.

PUT /api/v1/organization/theme

EXAMPLE REQUEST
JSON
{
    "organization_id": "Jk49fgm38",
    "theme_id": "93ODk5o1sL"
}
{
    "organization_id": "Jk49fgm38",
    "theme_id": "93ODk5o1sL"
}

Listing Domains ​

This endpoint will list all domains belonging to an organization.

GET /api/v1/organization/domain?id=Jk49fgm38

EXAMPLE RESPONSE
JSON
[
    // domains
]
[
    // domains
]

Adding a Domain ​

This endpoint adds an existing domain to an organization.

POST /api/v1/organization/domain

EXAMPLE REQUEST
JSON
{
    "id": "Jk49fgm38",
    "domain_id": "93ODk5o1sL"
}
{
    "id": "Jk49fgm38",
    "domain_id": "93ODk5o1sL"
}
EXAMPLE RESPONSE
JSON
{
    // domain
}
{
    // domain
}

Removing a Domain ​

This endpoint removes a domain from given organization.

DELETE /api/v1/organization/domain?id=Jk49fgm38&domain_id=93ODk5o1sL

Managing Themes ​

Themes can either belong to a user or an organization. They are also used on domains to overwrite settings.

Creating/Updating/Copying a Theme ​

This endpoint creates, updates, or copies a theme.

POST /api/v1/theme

EXAMPLE REQUEST
FormData:

logo_light: File
logo_dark: File
favicon: File
data: JSON {
    "id": "Jk49fgm38",
	"copy_id": null,
	"domain_id": null,
	"organization_id": null,
	"name": "My Theme",
	"settings": {
        // key value pairs
    }
}
FormData:

logo_light: File
logo_dark: File
favicon: File
data: JSON {
    "id": "Jk49fgm38",
	"copy_id": null,
	"domain_id": null,
	"organization_id": null,
	"name": "My Theme",
	"settings": {
        // key value pairs
    }
}

If neither the domain_id nor the organization_id are set, the theme will be created for the user.

EXAMPLE RESPONSE
JSON
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "93ODk5o1sL",
    "organization_id": null,
    "name": "My Theme",
    "settings": {
        // key value pairs
    },
    "is_default": false
}
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "user_id": "93ODk5o1sL",
    "organization_id": null,
    "name": "My Theme",
    "settings": {
        // key value pairs
    },
    "is_default": false
}

Listing Themes ​

This endpoint lists themes for the user, an organization, a subdomain, or a custom domain. If include_organizations is set to true, the list will contain all themes the user has directly or indirectly access to.

GET /api/v1/theme
GET /api/v1/theme?include_organizations=true
GET /api/v1/theme?organization_id=Jk49fgm38
GET /api/v1/theme?subdomain=sub
GET /api/v1/theme?domain=my-domain.com
GET /api/v1/theme
GET /api/v1/theme?include_organizations=true
GET /api/v1/theme?organization_id=Jk49fgm38
GET /api/v1/theme?subdomain=sub
GET /api/v1/theme?domain=my-domain.com
EXAMPLE RESPONSE
JSON
[
    // themes
]
[
    // themes
]

Deleting a Theme ​

This endpoint deletes a theme. If keep_settings is set to true, the settings will be applied to the domains the themes is used in before deletion.

DELETE /api/v1/theme?id=Jk49fgm38&keep_settings=true

Deleting a Theme File ​

This endpoint will delete a theme file for a them or a domain. The file can either be logo_light, logo_dark, or favicon.

DELETE /api/v1/theme/file?theme_id=Jk49fgm38&file=logo_light
DELETE /api/v1/theme/file?domain_id=93ODk5o1sL&file=favicon
DELETE /api/v1/theme/file?theme_id=Jk49fgm38&file=logo_light
DELETE /api/v1/theme/file?domain_id=93ODk5o1sL&file=favicon

Importing Data from Google Universal Analytics ​

Getting an Import Job ​

This endpoint returns the import job, if any, for the specified domain.

GET /api/v1/google/import/job?domain_id=A5kgYzK14m

EXAMPLE RESPONSE
JSON
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
	"google_user_id": "...",
	"google_user_email": "...",
	"domain": null,
    "from": null,
	"to": null
}
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
	"google_user_id": "...",
	"google_user_email": "...",
	"domain": null,
    "from": null,
	"to": null
}

Canceling an Import Job ​

This endpoint cancels the import job for given domain.

DELTE /api/v1/google/import/job?domain_id=A5kgYzK14m

Listing Google Analytics Profiles ​

This endpoint lists available profiles (views) for the connected Google Account.

GET /api/v1/google/import/profile?domain_id=A5kgYzK14m

EXAMPLE RESPONSE
JSON
[
    {
        "name": "Name",
        "id": "..."
    },
    // ...
]
[
    {
        "name": "Name",
        "id": "..."
    },
    // ...
]

Starting the Import ​

This endpoint starts the import after connecting the dashboard to your Google account.

POST /api/v1/google/import

EXAMPLE REQUEST
JSON
{
    "domain_id": "A5kgYzK14m",
    "property": "<GA view ID>",
    "from": "2022-01-01",
    "to": "2022-08-01"
}
{
    "domain_id": "A5kgYzK14m",
    "property": "<GA view ID>",
    "from": "2022-01-01",
    "to": "2022-08-01"
}
EXAMPLE RESPONSE
JSON
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
	"google_user_id": "...",
	"google_user_email": "...",
	"domain": "<GA view ID>",
    "from": "2022-01-01",
	"to": "2022-08-01"
}
{
    "id": "Jk49fgm38",
    "def_time": "2021-05-22T10:11:12.123456Z",
    "mod_time": "2021-05-22T10:11:12.123456Z",
    "domain_id": "A5kgYzK14m",
	"google_user_id": "...",
	"google_user_email": "...",
	"domain": "<GA view ID>",
    "from": "2022-01-01",
	"to": "2022-08-01"
}