Before you can start using our API, you must first have a key. All API requests require a key that is based on a user account. You can choose to use your own user account's API key or create a new user account for the purposes of accessing the API.

1. To retrieve a user's key, go to the Left-hand Navigation: Reports & More » Users » Edit User » API Keys.
   
   
   
   
2. The user account for making API requests must have the Can Access API user permission from Left-hand Navigation: Reports and More Icon » Groups.
   
   
   
   
3. When making an API request, you will need to include the user's API key to make a successful request.
   

   Reference:  You will see example requests reference the key parameter as "{my_key}".

Related Resources

• Gingr's API Topic Outline
• Gingr's API Uses Reference