API documentation — Plausible Analytics

Cited by

Facts read from this source

• Stats API read only Report an error

  “Plausible Stats API is a read-only HTTP interface for viewing historical and real-time stats.”

• Stats API endpoint Report an error

  “The /api/v2/query endpoint accepts simple and complex stats queries in the POST request body and returns the metrics as JSON.”

• Stats API plan Report an error

  “Stats API is a Business plan feature.”

• Stats API key scoping Report an error

  “API keys are scoped to one team. The team selected in the top-right menu when you create the key determines which sites it can query.”

• Stats API auth Report an error

  “you can authenticate your request by sending the key in the Authorization header of your request.”

• Stats API key roles Report an error

  “Role in the selected team Can create a key for that team? Owner, Admin, Editor or Billing Yes Viewer No”

• Stats API rate limit Report an error

  “API keys have a rate limit of 600 requests per hour by default. If you have special needs for more requests, please contact us to request more capacity.”

• Stats API metrics Report an error

  “Valid metrics are:”

• Stats API revenue metrics Report an error

  “average_revenue Revenue or null Average revenue per revenue goal conversion”

• Stats API dimensions Report an error

  “Event dimensions Valid dimensions include:”

• Stats API custom props Report an error

  “Custom properties can also be used as dimensions with the form event:props:<custom_prop_name>.”

• Stats API filter operators Report an error

  “The following operators are currently supported:”

• Stats API segments Report an error

  “Segments can be used in filters, in the form ["is", "segment", [<segment_id>]].”

• Stats API pagination Report an error

  “pagination optional Default: { "limit": 10000, "offset: 0 }”

• Stats API imported data Report an error

  “include.imports Default: false If true, tries to include imported data in the result.”

• Stats API imported limits Report an error

  “As imported data from Google Analytics or other sources is stored as aggregates, responses for queries with certain metrics, filters and dimensions may not contain imported data.”

• Stats API other APIs Report an error

  “Take a look at our Events API Reference if you want to record pageviews or custom events for your sites, or Sites API Reference if you want to manage your sites over the API.”

• Stats API legacy v1 Report an error

  “LOOKING FOR LEGACY STATS API V1 DOCS? Take a look here”

• Stats API key sites access Report an error

  “A Stats API key can query sites owned by the team it was created for. It cannot query: Sites owned by another team Sites where the key owner is only a Guest Viewer or Guest Editor”

• Stats API sites read access Report an error

  “A Stats API key can also use the read-only endpoints of the Sites API, for example to list the sites owned by its team. Creating, changing or deleting sites needs a Sites API key.”

• Stats API accuracy note Report an error

  “Our testing has shown this to be a small effect (less than 1 percent).”

• Stats API playground Report an error

  “The following examples are interactive and can be edited and run against your own data if you're logged in.”

Scores citing this record

• The Agency Developer Data access, export & self-hosting
• The Data Protection Officer Data access, export & self-hosting
• The E-Commerce Marketing Lead Data access, export & self-hosting
• The E-Commerce Marketing Lead Pricing transparency
• The Growth Analyst Goals, events, funnels & e-commerce
• The Growth Analyst Data access, export & self-hosting
• The Growth Analyst Pricing transparency
• The Public-Sector Site Owner Data access, export & self-hosting
• The Public-Sector Site Owner Pricing transparency
• The Skeptic Data access, export & self-hosting
• The Skeptic Pricing transparency