API keys are used for accessing Digiseg Insights Platform features through API integrations.
Log in as the user you want to be used when fetching data, click the profile picture and then “API keys” in the submenu. In this view you will be able to create and manage API keys.
API keys of a user
When you click “Create API key” you will be asked to provide a name for the key, a set of service grants (more detail below) and an expiry date. These can all be changed later, too.
After API key creation, a token is shown on the screen. This token is secret and will only be fully revealed this one time. We recommend keeping it in a password manager or vault system that you trust.
API keys permissions are managed by setting service grants. These grants each define a set of permissions that are granted to the API key. The most common type of grant is Audience data lookup, but there are many, so here is a set of descriptions for them.
| Service grant | Technical key | Description |
|---|---|---|
| Audience data lookup | audience.lookup |
Use the Audience Data API to fetch the audiences of IPs |
| Submit study event | study.event |
Use the Create Study Event endpoint |
| Read populations/benchmark data | populations.read |
Fetch populations/benchmark statistics |
| Read study data | study.read |
Fetch study data and query study statistics |
| Create and update studies | study.write |
Create and edit studies |
| Read account and member info | account.read |
Fetch account and member information |
| Create and update account | account.write |
Edit account and account memberships |
| Read usage statistics | usage.read |
Fetch usage statistics |
API keys have an expiry date. Digiseg will send notice emails to the API key owners before the keys expire. The expiry dates can also be extended, although we generally recommend to use the occasion to switch to a new key from time to time.