We've created a pre-built collection containing the methods required for testing our Datasets API integration and those required for creating custom widgets. This enables you to test these methods without the need for writing your own code when you might not have any code to hand, or for reference if you are experiencing errors with your own code.
In order to use our collection, and to combine ease of use with speed, we recommend downloading Postman and importing our collection into your Postman workspace.
Installing Postman
Postman is a REST client that allows developers to test, develop and document APIs. This can make testing Datasets API and custom Widgets quick and simple. Download a free version of Postman. The basic plan is sufficient for importing and testing this collection.
After installing Postman, you can download the collection below and import it into your own environment.
Importing the collection to your Postman workspace
Using Postman for testing the Datasets API methods
Tip: If you're only testing our methods, don't change the dataset id or the content contained in the Body.
GET — Datasets authentication
GET should be selected
URL should be set to: https://api.geckoboard.com/
Click the Authorisation tab, and under Type select Basic Auth
In the Username field add your API key
Leave the Password field blank
PUT — Create dataset
Make sure PUT is selected
Update the URL field by adding an id for your dataset, like so: https://api.geckoboard.com/datasets/:id
Click the Authorisation tab, and under Type select Basic Auth
In the Username field add your API key
Leave the Password field blank
Click the Headers tab
In the Key field add Content-Type
In the Value field add application/json
Click the Body tab, then select Raw
Add you schema here
If you're ready to create the dataset, click Send
Click Save to save your request in Postman
POST — Add or append data
Make sure POST is selected
Update the URL field to include your dataset id, and append /data, like so: https://api.geckoboard.com/datasets/:id/data
Click the Authorisation tab, and under Type select Basic Auth
In the Username field add your API key
Leave the Password field blank
Click the Headers tab
In the Key field and add Content-Type
In the Value field add application/json
Click the Body tab, then select Raw
Add your dataset formatted as JSON here
If you're ready to POST the dataset to Geckoboard, click Send
Click Save to save your request in Postman
PUT — Replace all data in dataset
Make sure PUT is selected
Follow the same above steps as POST, then:
In the Body tab, select Raw
Add the dataset that will replace all current data
Click Send
Click Save to save your request in Postman
DELETE — Delete a dataset
Make sure DELETE is selected
Update the URL field to include your dataset id, like so: https://api.geckoboard.com/datasets/:id
Click the Authorisation tab, and under Type select Basic Auth
In the Username field add your API key
Leave the Password field blank
Click Send, and the dataset will be deleted from Geckoboard
Click Save to save your request in Postman
Using Postman for testing custom widgets
Create a new request or use one of the examples
Select POST
Update the URL to reflect the following and be sure the widget key is added: https://push.geckoboard.com/v1/send/widget-key-here
Select the Headers tab
In the Key field and add Content-Type
In the Value field add application/json or application/xml
On the Body tab, select Raw
Add your data formatted as JSON or XML as per our documentation
Click Send to POST payload to Geckoboard
Click Save to save request in Postman