Authenticate your Geckoboard account

Authenticate your account when using the Datasets API by including your personal API key in the request.

What's an API key?

An API key is an authorization code used to identify you as the requester.

You can find your Geckoboard API key by following these steps.

You can test if your API key is working by peplacing your-api-key with your API key. Make sure you keep the colon (:) in the request.

curl https://api.geckoboard.com/ -u "your-api-key:"

You should get a 200 response containing {}

Tip

If you missed including the : or are still asked for a password, simply hit the Enter key on your terminal.

Verify that your API key is valid with the #ping method:

gb.ping(callback);
Attribute Type Required?
  callback Function Yes

Verify that your API key is valid with the ping method:

client.ping

Example

Geckoboard.client('good-api-key').ping # => true
Geckoboard.client('bad-api-key').ping # => raises Geckoboard::UnauthorizedError

Verify that your API key is valid with the ping method:

client.ping()

Example

client('good-api-key').ping() # => true
client('bad-api-key').ping() # => raises Exception

Important note

Your Geckoboard API key is just as powerful as your login credentials, so keep it safe. Do not share it in publicly accessible areas such GitHub, client-side code, and so forth.

Get help

If you’re having problems with authentication get in contact with our Customer Success team who will gladly help you.

Was this article helpful?

Awesome! 👍  Thanks so much for your feedback!