Ingest API
This guide provides a comprehensive walkthrough of the Ingest API dashboard. You will learn how to monitor data ingestion performance and configure security settings for your API keys to ensure that data is sent securely and efficiently.
Accessing the Ingest API Dashboard
You can navigate to the Ingest API dashboard directly from the Home page.
From the Home dashboard, locate the APIs section.
Click on the Ingest API button to open the dashboard.
Monitoring Ingestion Performance
The Ingest API dashboard provides two key graphs for monitoring the health and performance of your data ingestion pipeline.
User Events: This graph displays the volume of incoming events and the average time it takes to process them. You can hover over the bars to see specific data points for ingestion time.
Database Writes: This graph shows the write operation throughput and performance metrics, helping you understand the load on your database.
Configuring API Key Settings
To enhance security, you can control how your API keys are used. The settings are divided into two sections:
Integration Write-Only API Key: This key can only be used to send (write) data to the platform.
Integration Read & Write API Key: This key can be used to both send (write) and retrieve (read) data.
How to Edit API Key Settings
To begin making changes, you must first enter edit mode.
Scroll to the API key section you wish to configure (e.g., "Integration Write-Only API Key Settings").
Click the Edit button in the top-right corner of the section. The fields will become editable.
Restricting Access by IP Address
For added security, you can limit API access to a list of trusted IP addresses. This ensures that only authorised servers or services can send data.
In edit mode, under Access Control, select Specific locations.
Click the Add IP address button.
In the New Allowed IP Address pop-up window, complete the following fields:
IPv4 address: Enter the static IP address you want to add to the allowlist.
Description: Provide a memorable name for the IP address (e.g., "Main Production Server"). This helps you identify its purpose later.
Click Add. The IP address will be added to the list.
Repeat this process for any other IP addresses you wish to add.
Allowing Specific Profile Events
You can control exactly which types of events are accepted through the API. By default, all profile events are allowed, but you can restrict this to a specific list.
In edit mode, under Allowed Profile Events, select Specific Profile Events.
In the enter event name field, type the exact name of the event you wish to allow (e.g.,
login,page_view).Click the Add button. The event name will appear as a tag in the list of allowed events.
Saving Your Changes
Once you have finished configuring the settings, you must save them for the changes to take effect.
Click the Save Changes button at the top-right of the section you were editing.
A confirmation message, Changes saved, will appear briefly in the top-right corner of the screen, confirming that your updates have been applied successfully.
Last updated