Authentication

Authentication

All Analytics API endpoints require authentication using an API key provided in the request headers.

Authentication Header

Include your API key in the Authorization header of each request using Bearer token authentication:

headers: {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
}

API Key Generation

Get an API key

1. Log in to the Inkeep Dashboard
2. Navigate to the Projects section and select your project
3. Open the Integrations tab
4. Click Create Integration and choose API from the options
5. Enter a Name for your new API integration.
6. Click on Create
7. A generated API key will appear that you can use to authenticate API requests.

API Key Access Levels

API keys have different access levels depending on the integration type:

• API Integration Keys: Provide both read and write access to the Analytics API
• Other Integration Keys: Some integration types may have restricted access (write-only access)

Always use an API Integration key for full access to all Analytics API functionalities.

Integration Types and Access Levels

Project Scoping

All API keys are scoped to the specific project in which they were created. An API key cannot be used to access data from other projects. This ensures proper security isolation between different projects in your Inkeep account.

Security Best Practices

When using the API key in your applications:

1. Never expose the API key in client-side code
2. Use environment variables to store the key securely

Rate Limiting

The API implements rate limiting to prevent abuse. If you exceed the rate limits, you may receive a 429 Too Many Requests response. Implementation details vary based on your usage plan.

For more information on API access or issues with authentication, contact Inkeep support.