Skip to main content
The Syteca Data Connector exposes nine REST endpoints under a single base URL, authenticated with a per-user API key. This page covers the conventions shared by all endpoints — base URL, authentication, time parameter format, pagination, and status codes. Per-endpoint detail (parameters, response shape, examples) lives on each endpoint page.
NOT AVAILABLE IN SAAS. The Data Connector is on-premises only.

​
Base URL

All endpoints share the same base URL:
Replace <hostname> with the computer name where the Data Connector is installed — specifically, the value in the Issued To field of the HTTPS certificate you set up during installation.

​
Authentication

Every API call must include an ApiKey request header.
​
string
required
The Active API Key from your Management Tool account. See Manage → Get an API key for how to obtain it.
Example header value:
The API key inherits the underlying Management Tool user’s permissions. API calls only return data the user would be able to see in the Management Tool — Client permissions, administrative permissions, and User-to-User access scope all apply.

​
Time parameter conventions

Five of the nine endpoints accept optional start and end time parameters to filter results by date/time range:

​
Accepted formats

All time parameters accept ISO 8601-style strings in three precision levels:

​
Rules when parameters are omitted

  • Both start and end omitted → all sessions in the database are included.
  • start omitted, end provided → all sessions started before end.
  • end omitted, start provided → all sessions started or finished after start.

​
Session boundary clipping

For endpoints that work over sessions:
  • If a session started before the start date/time, the first activity after start is considered the session start in the response.
  • If a session finished after the end date/time, the last activity before end is considered the session end in the response.

​
Pagination

Three endpoints support pagination because their result sets can exceed the 1000-record cap:
Requesting more than 1000 records in a single call returns HTTP 400 Bad Request. The maximum page size is 1000 across all three paginated endpoints.
The parameter naming is inconsistent across the three paginated endpoints — sessionCount / alertCount / count for page size, and pageIndex / afterActivityId / afterId for the cursor. This is the API’s actual behavior; per-endpoint pages document each endpoint’s exact parameter names.

​
Status codes

​
Endpoints

Overview

What the Data Connector is and when to use it.

Install

Prerequisites, MSI install, certificate setup.

Power BI example

End-to-end use case calling these endpoints from Power BI.

Manage

Applications tab, get your API key, deactivate.