Developer Documentation (API)

Get a list of templates

GET Request
Endpoint URL https://veski.leikbreytir.is/api/pass/statistics/{pass-template-uid}?timeFrame={timeFrame}&day={day}
Purpose
Get detailed statistics about passes of a template. This returns timelines for the requested time frame and shows when and how many passes have been created, updated, deleted (deactivated) or saved as well as the operating systems that have been used.

Required input parameters

  • HTTP Authorization Header that contains your API key
  • pass-template-uid – the UID of the pass template for whose passes you want to get statistics for
  • timeFrame – the time frame you want to get statistics for. Supported values are day, week, month and year. Year is only supported for templates with less than 10.000 passes.
  • day – the day that determines what time you’ll receive statistics for. Supported are either the string “today” or a day in the format Y-m-d, e.g. 2025-01-15

Returned values

JSON-Array containing the following sub-arrays
  • activeRegistrationsTimeline – shows how many passes have been activated (means saved on a smartphone) per day.
  • inactiveRegistrationsTimeline – shows how many passes have been deactived (removed from a phone or push notifications have been deactivated) per day.
  • createdPassesTimeline – shows how many passes have been created per day
  • updatedPassesTimeline – shows how many passes have been updated per day
  • sentPushNotificationsTimeline – the number of times a push notification has been triggerd (which means we’ve informed the phone that there’s something new)
  • receivedPushNotificationsTimeline – the number of times the phone has actually downloaded the new version of a pass
  • passesPerOperatingSystem – contains three key value pairs: iOS, Android, WindowsPhone. Each key contains the number of passes that are active right now or have been active per operating system.
Example output: 
{
    "activeRegistrationsTimeline": [
        {
            "date": "2019-03-10",
            "noOfPasses": "268"
        }
    ],
    "inactiveRegistrationsTimeline": [
        {
            "date": "2019-03-10",
            "noOfPasses": "9"
        }
    ],
    "createdPassesTimeline": [
        {
            "date": "2019-03-10",
            "noOfPasses": "24"
        }
    ],
    "updatedPassesTimeline": [
        {
            "date": "2019-03-10",
            "noOfPasses": "541"
        }
    ],
    "sentPushNotificationsTimeline": [
        {
            "date": "2019-03-10",
            "noOfPasses": "359"
        }
    ],
    "receivedPushNotificationsTimeline": [
        {
            "date": "2019-03-10",
            "noOfPasses": "348"
        }
    ],
    "passesPerOperatingSystem": {
        "iOS": 143,
        "Android": 125,
        "WindowsPhone": 0
    }
}