Keytiles APIs

Preface

APIs are central part of Keytiles design from moment zero as Keytiles is following "api first" approach. This means all the GUIs we provide are also using exactly the same endpoints we document here to handle data collection, data query (and visualization) and User / Container management.

We document our contracts in OpenApi 3.x format which you can find in our Github area in this repository: https://github.com/keytiles/keytiles-public-api

All our APIs are following semantic versioning - which helps you to feel how big the difference is between different versions.

Hit Collection API

The Hit Collection API is providing the possibility to send in events into Keytiles and let the system process them.

This is an RPC style API so simply a collection of methods to pick up data.

For website owners / developers we provide a drop-in Javascript - called the Tracking Script - which you can easily include into your web page and it will use this Hit Collection API in the background to send in data. See Getting started with Keytiles for more details!

Versions:

v1.1 - current

v1.0 - deprecated

Kept for diff purposes only

Query API

The Query API provides a set of GET endpoints to query statistics data stored by Keytiles service.

Versions:

v2.1 - current

Not everything is migrated from v1.0 into this new version yet so v1.0 is still valid.

Explanation article: QueryAPI v2 - Webhits Event counter queries

v2.0 - deprecated

v1.0 - current (partially)

But a few endpoints in it are already deprecated!

We are moving the endpoints from this version into v2.x step by step - until not complete we can not deprecate this version!

Management API

API to manage Users, Containers and permissions.

This is mostly RESTful API but we also have some RPC style endpoints in it.

Versions:

v1.1 - current

v1.0 - deprecated

Kept for diff purposes only