Using the Data Warehouse API

Overview

Want to get started? The Data Warehouse API must be enabled for your account. Please contact SureView Support and we can activate it for you.

What Data Can I Access?

Events

Event Records

How Far Back Can I Query?

In practice, most accounts will hit the 100,000-record limit long before the 90-day one. A single week of EventRecords can exceed 100,000 rows for a high-volume account. Start with a narrow window (e.g. 3 days), confirm it succeeds, and only widen it once you're confident the record count will stay under the limit. See Errors and Rate Limits below for the exact failure conditions.

How Does Authentication Work?

1. API Key: A unique key that identifies your organisation's account.
2. JWT Token: A short-lived access token that verifies your identity. You can set how long it remains valid when generating it.

⚠️ Important: Keep these credentials private. They provide full access to all alarm events and records for your account. Do not share them publicly or include them in code repositories.

1. Log in to SureView Suite.
2. Go to Account Settings.
3. Navigate to the Data Warehouse Access Configuration section.
4. Here you can view, copy, or regenerate your API Key and JWT Token.

• Click Regenerate next to the JWT token.
• Choose how many hours you want the token to remain valid.
• Click Save. Your new token will be ready to use.

• Click Regenerate next to the API Key.
• Your new key is generated immediately.

If you do not see the Data Warehouse Access Configuration section in your Account Settings, please contact SureView Support to enable Data Warehouse access for your account.

Use Cases & Integrations

• Microsoft Excel: Pull data directly into a spreadsheet using Excel's built-in Power Query feature. Set up a dynamic query to automatically refresh and pull the latest data on demand.
• Microsoft Power BI: Connect Power BI to the API to build rich, interactive dashboards.
• Tableau: Import your alarm event data into Tableau for advanced visualisation.
• Crystal Reports: Feed your data into Crystal Reports for structured reporting.
• Any tool that supports REST APIs: The API returns data in CSV or JSON format, making it compatible with a wide range of platforms and languages.

Getting Started

Enable Data Warehouse Access

Before you can use the API, Data Warehouse access needs to be enabled for your account. If you don't see a Data Warehouse Access Configuration section in your Suite Account Settings, contact SureView Support to get it turned on.

---

Getting Your Credentials

All requests to the API require two credentials. Both are available in SureView Suite 

Account Settings > Data Warehouse Access Configuration.

 

API Key

A static key tied to your organisation's account. It does not expire unless you manually regenerate it. To create or replace one, click Regenerate next to the API Key field. This is passed on every request as the X-Api-Key header

.

JWT Token

A time-limited token used to verify your identity. When generating one you choose how long it stays valid, in hours. To create or replace one, click Regenerate next to the JWT Token field, set your preferred expiry, and click Save. This is passed on every request as the Authorization header.

Keep these credentials private. Together they grant full access to all alarm events and event records for your account. Do not share them in unsecured files or locations others can access.

---

The Endpoints

The API base URL is:

https://suite.sureviewops.com/datawarehouseapi/

Two endpoints are available:

Endpoint	Description
/Events	A summary record for each alarm event
/EventRecords	A detailed log of every action taken within events

---

Query Parameters

Parameter	Description
startDate	Start of the date range to query. Format: YYYY-MM-DD. Required unless using lastUpdated.
endDate	End of the date range to query. Format: YYYY-MM-DD. Required unless using lastUpdated.
lastUpdated	Returns events updated since this datetime. Cannot be combined with startDate or endDate.
fileType	Output format. Omit for CSV (the default), or pass fileType=json for JSON output.

A single request is limited to a maximum date range of 90 days and a maximum of 100,000 records - whichever is hit first will cause the request to fail. Most high-volume accounts will hit the 100,000-record limit well before the 90-day one, so treat 90 days as a theoretical ceiling rather than a practical target. If you are querying a high-volume account, start with shorter windows (1 to 7 days) and narrow further if you still see errors.

---

Errors and Rate Limits

The following status codes can be returned by the API when data retrieval was not successful:

Status Code	Description
400	Bad Request - Invalid Date Parameters. This is returned when a required parameter is missing, a parameter is not in a valid date format, the range between startDate and endDate is greater than 90 days, or the requested range would return more than 100,000 records. The response doesn't indicate which of these caused it, so check your request against all four.
401	Unauthorized. Returned if the API Key or JWT Token are missing or incorrectly added to the request, are malformed or don't belong to the same tenancy, or if the JWT Token has expired.
429	Too Many Requests. Returned when you exceed the number of requests allowed within a time frame. The current limit is 10 requests within any 10-minute period. If you receive a 429, wait before retrying rather than retrying immediately.
500	Internal Server Error. Returned if an error occurs within the API during the request. If this persists, please contact Customer Support.

Planning a bulk export? At 10 requests per 10 minutes, pulling a large amount of history in small chunks takes real time - a year of data split into daily requests is 365 requests, which takes at least roughly 6 hours even with no errors. Any script or tool built against this API should pace its requests and back off (rather than retry immediately) when it receives a 429.

---

Making a Request

Pass both credentials as headers on every request:

Header	Value
X-Api-Key	Your API Key
Authorization	Your JWT Token

Example using curl:

curl -X GET \
"https://suite.sureviewops.com/datawarehouseapi/Events?startDate=2026-01-01&endDate=2026-01-07" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Authorization: YOUR_JWT_TOKEN"

This example uses a 7-day range as a safe starting point. Even 7 days can exceed 100,000 records for high-volume EventRecords accounts, so check the response and narrow the range further if you receive a 400.

By default the API returns a CSV file, which works directly with Excel, Power BI, and most other reporting tools. If you need JSON instead, add fileType=json to the request URL.

Connecting in Microsoft Excel (Power Query)

Prerequisites

Step 1 – Open the "Get Data" Wizard

1. Open a new, blank Excel workbook.
2. Go to the Data tab on the ribbon.

3. Click Get Data > From Other Sources > From Web.
   

    

Step 2 – Enter the URL and Credentials

1. In the dialogue box, click the Advanced option at the top.
2. In the URL field, enter the appropriate endpoint URL:
   Events:

   https://suite.sureviewops.com/datawarehouseapi/Events?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD

    
   Event Records:

   https://suite.sureviewops.com/datawarehouseapi/EventRecords?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD

   (Replace YYYY-MM-DD with your desired date range, e.g. 2026-01-01 and 2026-01-07 - see the note on the 100,000-record limit below before choosing a wider range)
    
3. Under HTTP request header parameters, add your two credentials:

   Header Name	Value
   X-Api-Key	(Paste your API Key here)
   Authorization	(Paste your JWT Token here)

4. Click OK.
   

Step 3 - Load or Transform the Data

• A preview window will appear showing your data.
• To load static data for the dates you specified: click Load — you're done!
• To set up a dynamic query that automatically pulls a rolling window of recent data every time you refresh: click Transform Data and continue to the next steps.
  

Before you continue: Power Query does not automatically split a request or retry on an error, so the dynamic query below can only ever pull data as a single request. If your account's volume means that request would exceed 100,000 records, refreshing the query will fail with an error rather than returning partial data. Start with a short window (the example below uses 7 days) and only increase it once you've confirmed the record count comfortably stays under the limit. Repeated manual refreshes while you're testing this also count towards the API's rate limit of 10 requests per 10 minutes.

Step 4 - Set Up a Dynamic Date Range (Optional)

1. In the Power Query Editor, click the Home tab.
2. Click Advanced Editor.
3. Delete all the existing code and replace it with the dynamic query script below.
4. Update the placeholder values for X-Api-Key and Authorization with your actual credentials.
5. Adjust the day range if needed. -90 is the hard ceiling, but most accounts will hit the 100,000-record limit long before that - start at -1 and increase gradually, refreshing after each change to confirm it still loads successfully.

let
    Today = Date.From(DateTime.LocalNow()),
    StartDate = Date.AddDays(Today, -1),
    EndDateText = Date.ToText(Today, "yyyy-MM-dd"),
    StartDateText = Date.ToText(StartDate, "yyyy-MM-dd"),
    BaseUrl = "https://suite.sureviewops.com/datawarehouseapi/Events",
    Source = Csv.Document(
        Web.Contents(BaseUrl, [
            Query=[startDate=StartDateText, endDate=EndDateText],
            Headers=[#"X-Api-Key"="YOUR_API_KEY", Authorization="YOUR_JWT_TOKEN"]
        ]),
        [Delimiter=",", Columns=36, Encoding=1252, QuoteStyle=QuoteStyle.Csv]
    ),
    #"Promoted Headers" = Table.PromoteHeaders(Source, [PromoteAllScalars=true])
in
    #"Promoted Headers"

let
    Today = Date.From(DateTime.LocalNow()),
    StartDate = Date.AddDays(Today, -1),
    EndDateText = Date.ToText(Today, "yyyy-MM-dd"),
    StartDateText = Date.ToText(StartDate, "yyyy-MM-dd"),
    BaseUrl = "https://suite.sureviewops.com/datawarehouseapi/EventRecords",
    Source = Csv.Document(
        Web.Contents(BaseUrl, [
            Query=[startDate=StartDateText, endDate=EndDateText],
            Headers=[#"X-Api-Key"="YOUR_API_KEY", Authorization="YOUR_JWT_TOKEN"]
        ]),
        [Delimiter=",", Columns=47, Encoding=1252, QuoteStyle=QuoteStyle.Csv]
    ),
    #"Promoted Headers" = Table.PromoteHeaders(Source, [PromoteAllScalars=true])
in
    #"Promoted Headers"

1. Click Done.

Step 5 - Load and Refresh

1. Back in the Power Query Editor, click Close & Load on the Home tab.
2. Your data will appear in a new Excel sheet as a formatted table.
3. To refresh the data at any time, go to the Data tab and click Refresh All - this will re-run the query and pull the latest data.

⚠️ Note: Refreshing will overwrite any manual changes made directly to the data cells. Keep any custom analysis in a separate sheet.

Frequently Asked Questions

Data Warehouse access must be enabled for your account by SureView. Once enabled, users with Administrator permissions in SureView Suite can access the credentials needed to connect. Contact SureView Support to get started.

A single request is capped at 90 days and 100,000 records - whichever limit you hit first will return a 400 error. Most high-volume accounts hit the 100,000-record limit well before 90 days, so start with a narrow window (e.g. 1 or 2 days) and only widen it once you've confirmed the record count stays under the limit.

The request fails with a 400 error rather than returning a partial or truncated result. Split your date range into smaller windows, request each one separately, and combine the results.

Yes. You can make up to 10 requests within any 10-minute period; exceeding this returns a 429 error. If you're pulling a large amount of history in narrow chunks to stay under the 100,000-record limit, make sure your process paces its requests and waits before retrying after a 429, rather than retrying immediately.

Log back in to SureView Suite, go to Account Settings > Data Warehouse Access Configuration, and click Regenerate next to the JWT Token. Set your preferred expiry and save it, then update your query or tool with the new token.

Yes. The API is a standard REST API that any tool or developer with HTTP request capabilities can connect to. It has been successfully used with Power BI, Tableau, Crystal Reports, and custom scripts.