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

  1. GET should be selected

  2. URL should be set to: https://api.geckoboard.com/

  3. Click the Authorisation tab, and under Type select Basic Auth

  4. In the Username field add your API key

  5. Leave the Password field blank

Fields to be completed in the method

PUT — Create dataset

  1. Make sure PUT is selected

  2. Update the URL field by adding an id for your dataset, like so: https://api.geckoboard.com/datasets/:id

  3. Click the Authorisation tab, and under Type select Basic Auth

  4. In the Username field add your API key

  5. Leave the Password field blank

  6. Click the Headers tab

  7. In the Key field add Content-Type

  8. In the Value field add application/json

  9. Click the Body tab, then select Raw

  10. Add you schema here

  11. If you're ready to create the dataset, click Send

  12. Click Save to save your request in Postman

POST — Add or append data

  1. Make sure POST is selected

  2. Update the URL field to include your dataset id, and append /data, like so: https://api.geckoboard.com/datasets/:id/data

  3. Click the Authorisation tab, and under Type select Basic Auth

  4. In the Username field add your API key

  5. Leave the Password field blank

  6. Click the Headers tab

  7. In the Key field and add Content-Type

  8. In the Value field add application/json

  9. Click the Body tab, then select Raw

  10. Add your dataset formatted as JSON here

  11. If you're ready to POST the dataset to Geckoboard, click Send

  12. Click Save to save your request in Postman

PUT — Replace all data in dataset

  1. Make sure PUT is selected

  2. Follow the same above steps as POST, then:

  3. In the Body tab, select Raw

  4. Add the dataset that will replace all current data

  5. Click Send

  6. Click Save to save your request in Postman

DELETE — Delete a dataset

  1. Make sure DELETE is selected

  2. Update the URL field to include your dataset id, like so: https://api.geckoboard.com/datasets/:id

  3. Click the Authorisation tab, and under Type select Basic Auth

  4. In the Username field add your API key

  5. Leave the Password field blank

  6. Click Send, and the dataset will be deleted from Geckoboard

  7. Click Save to save your request in Postman

Using Postman for testing custom widgets

  1. Create a new request or use one of the examples

  2. Select POST

  3. Update the URL to reflect the following and be sure the widget key is added: https://push.geckoboard.com/v1/send/widget-key-here

  4. Select the Headers tab

  5. In the Key field and add Content-Type

  6. In the Value field add application/json or application/xml

  7. On the Body tab, select Raw

  8. Add your data formatted as JSON or XML as per our documentation

  9. Click Send to POST payload to Geckoboard

  10. Click Save to save request in Postman

Did this answer your question?