Data API

The Data API dashboard is your central hub for monitoring, managing, and securing direct query access to your data. Use this page to analyse query performance, inspect individual query logs, and configure cache settings and access controls to ensure your API is both fast and secure.

Accessing the Data API Page

To get to the Data API dashboard, follow these steps:

1. From the main Workspace Overview, navigate to the left-hand sidebar.

2. Click on the Infrastructure icon

3. From the Infrastructure sub-menu, select Data API.

Monitoring API Performance

The top section of the dashboard gives you a high-level view of your API's performance and throughput.

Database Reads

This chart visualises the performance of read queries made against the API over time.

• Throughput (QPS): Shows the number of Queries Per Second being handled by the API.

• Response Time: The average time, in seconds, for the API to respond to a query.

• Performance Chart:

  • The bar chart at the top shows the volume of queries over time.

  • The line chart below it shows the response times at different percentiles (p50, p90, p99). This helps you understand not just the average speed, but also the performance for the different queries.

Analysing Query Logs

The Query Logs table provides a detailed, historical record of every query executed via the Data API. This is invaluable for debugging, optimising slow queries, and understanding data access patterns.

Each entry in the log includes:

• Latest Run: The timestamp of when the query was last executed.

• Query: A snippet of the SQL query. You can click the arrow to expand the row and view the full query text.

• Source: The origin of the query (e.g., Dashboard).

• Occurrences: The number of times this specific query has been run.

• p50 / p90 / p99: The 50th, 90th, and 99th percentile response times for that individual query, helping you pinpoint which specific queries are performing poorly.

Configuring Data API Settings

You can fine-tune your API's performance and security settings to meet your application's needs.

To begin, click the Edit button in the top-right corner of the Settings panel.

Cache Configuration

Caching stores the results of frequent queries, which can dramatically improve response times and reduce the load on your database.

• Cache Time-To-Live (minutes): Enter a value in minutes to specify how long query results should be cached. A value of 5 means that if the same query is made within five minutes, the cached result will be returned instead of running the query again.

• Disable cache: Tick this checkbox to turn off caching entirely. This is generally not recommended for production environments unless you require real-time data for every request.

Access Control

For enhanced security, you can restrict which IP addresses are allowed to access the Data API.

1. In the settings panel, under Access Control, you have two options:

   • Anywhere: Allows access from any IP address (less secure).

   • Specific locations: Restricts access to a whitelist of IP addresses you define.

2. To add an allowed IP address, select Specific locations and click the + Add IP address button.

3. In the New Allowed IP Address modal that appears:

   • Enter the IPv4 address.

   • Provide a descriptive name for the IP address (e.g., "Office VPN" or "Production Web Server").

   • Click Add.

4. Repeat the process for any other IP addresses you need to add.

5. Once you have configured all settings, click the Save button at the bottom of the panel to apply your changes.