Announcing the KPI Service
Posted Apr 26, 2015
We’ve expanded your options to pull data from your adjust dataset with the KPI Service: a pull API for all of your statistics out of the adjust dashboard. Need to segment, filter, and group heavily for internal analytics purposes? That’s where the KPI Service comes in. I’ll go through some of the key use cases and usage here.
In essence, the KPI Service is a JSON pull API, which returns a JSON object on your GET request. You can freely specify which KPIs, which dates, which countries, device types, so on and so forth.
You authenticate by adding a personal user token to your request. All connections should be made over HTTPS for this reason, but the endpoints will also respond to HTTP.
There are three types of queries:
Cohorts. These correspond to the main three sections of your dashboard - indeed, because that’s the data structure they’re driven on.
To get started, here’s a simple query for some basic app data.
which would return something like:
"kpis": ["sessions", "installs"],
"countries": ["de", "uk"],
"name": "app name",
"name": "Network 1",
"kpi_values": [100, 299]
"name": "Network 2",
"kpi_values": [557, 880]
The real magic happens when you start segmenting, filtering, and grouping your data. The adjust dashboard can be easily filtered by country, by campaign and source, by device type and so on - but the API gives you an even stronger grip on manipulating these segments to get exactly the data you need.
Filters are applied as GET parameters to each query, and can bring you down to specific countries and device types. Grouping is applied by filling the
grouping parameter with an ordered list of the groups you want to see.
For example, a query with these parameters:
will return your request KPIs, filtered to tablets in the DACH countries, and grouped (in order of priority) by trackers, weeks, and events. For the event KPIs that you select, the results are per-event, nested into per-week, nested into trackers:
If we change the order, we’ll also get different nesting:
Looks cool, huh?
This logic is, you’ll recognise, equivalent to the order of operations in an SQL
GROUP BY query or the top-down sorting in an Excel pivot creation dialog.
We’re pretty excited about this and working on releasing additional functionality and tools to explore your data further.
This complements the callbacks API, where we push you the data in real-time to your server endpoint, as well as the extensive CSV reporting options we provide. All the better to understand what your data is all about.
The KPI Service is currently in closed beta, and currently available for clients with dedicated account managers, while we tweak the spec and squash a couple of edge cases. Please ping your AM rep to receive a user token for the API.