Skip to main content

How to get started with the Stats API using Postman

Postman is a simple interface that you can use for our stats API. To help you get started, here are the step by step instructions:

1) Log in to your Postman account.

2) Go to "My Workspace" and then "Collections" to create a new collection. Feel free to give it a descriptive name such as "Plausible Stats API".

3) Once you've created the collection, you should have the authorization tab open in which you can select the Bearer Token type for authorization:

Select the Bearer Token type for authorization

4) In the Token field, you should paste your Plausible Stats API key. You can obtain the Stats API key for your account by going to your Plausible account settings.

5) Once that's done, go ahead and save the collection at the top right:

Save the collection at the top right

6) Then add a new request to this collection and again feel free to give it a descriptive name:

Add a new request to this collection

7) Now, you can copy an example query from our stats API documentation, and paste it into the request field as follows:

Copy an example query from our documentation, and paste it

This will automatically read the different parameters and display them at the bottom. You can modify the parameters from the URL and in the bottom section too.

8) Hit send and you should see the response. This should be formatted as JSON by default. You can choose some other formatting if you like.

9) Now, you probably want to export this data. For that, you can either download the response as a .json file (Save Response), or copy it to your clipboard:

Download the response as a .json file (Save Response)

10) To convert the data into the CSV format, you should copy the response to your clipboard, and paste it into a tool like this one.

You can save the request to use it again in the future. You can also create new ones and save them as well. Have fun exploring!