Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/plausible/index.ts>default#getBreakdown

A zero-dependency, TypeScript library for interacting with the Plausible Analytics API, written in Deno!
Latest
method default.prototype.getBreakdown
import { default } from "https://deno.land/x/plausible@v2.2.1/index.ts";

This function allows you to breakdown your stats by some property. If you are familiar with SQL family databases, this function corresponds to running GROUP BY on a certain property in your stats.

Check out the properties section for a reference of all the properties you can use in this query.

Type Parameters

Property extends Properties
Metric extends Metrics

Parameters

period: Period
metric: Metric
property: Property
optional
filter: string | null
optional
limit: number | null
optional
page: number | null
optional
date: string | null