APIs
Statistics API

Intro
We have created a separate service for statistics about your Kindly chatbots. This service is named Sage and lives at sage.kindly.ai. The statistics you can view in the Kindly platform are provided by Sage. You can collect statistics for your own purposes from the same API that the platform uses.
Sage has its own database which contains only non-personal data. When end users chat with chatbots their messages are stored and processed in Kindly's database, and these can be manually or automatically deleted after some time to protect the end user's privacy.
The data in Sage's database will not be deleted, but this data doesn't contain the user's message or any personal metadata, only an indication that someone messaged the bot at a specific time. This way we can keep aggregated statistics such as the number of chats per day, while also allowing the end user to have their privacy protected.
How to query
Authentication
Sage auth sequence diagram
﻿
If you have the required permissions, you can create a permanent API key in the platform. This long-lived key can be used by a programmatic service you create to obtain short-lived JWTs which can then be used for statistics requests.
Send API key to api.kindly.ai to receive JWT:
Shell
curl --request GET \
  --url 'https://api.kindly.ai/api/v2/bot/<BOT_ID>/sage/auth' \
  --header 'authorization: Bearer <API_KEY>'
curl --request GET \
  --url 'https://api.kindly.ai/api/v2/bot/<BOT_ID>/sage/auth' \
  --header 'authorization: Bearer <API_KEY>'
﻿
Send a request to sage.kindly.ai to test your new token
Shell
curl --request GET \
  --url 'https://sage.kindly.ai/api/v1/stats/bot/<BOT_ID>/sessions/messages?from=2019-01-01&to=2019-02-01' \
  --header 'authorization: Bearer <JWT>'
curl --request GET \
  --url 'https://sage.kindly.ai/api/v1/stats/bot/<BOT_ID>/sessions/messages?from=2019-01-01&to=2019-02-01' \
  --header 'authorization: Bearer <JWT>'
﻿
Timezone
﻿List of tz database time zones﻿
All time values in the database are stored as UTC. If you want results in your local timezone, which takes into consideration daylight saving time and other irregularities, you can provide a tz argument to your API request with the tzdb name of the timezone you want. It would look like this for Oslo:
GET https://sage.kindly.ai/api/...&tz=Europe/Oslo
The timezone parameter is important to consider if you are making a request where the data is aggregated by day. If someone messages the bot at 9 p.m. (summertime) on Monday in California, this is stored in the database as occurring at 4 a.m. on Tuesday. To get the API results scoped for California time, you would send a request with tz=America/Los_Angeles. In other words: you must consider the location's timezone and adjust for it.
Granularity
Some aggregations can use a granularity parameter, for example, the aggregation that counts the number of messages per hour, day, or week. You can specify this with granularity=hour, etc. These default to granularity=day if not otherwise specified. Note that hour granularity is only allowed if the time between from and to is one week or less.
Source and language
The events that are aggregated by Sage are labeled by which source and language the user and bot were chatting with. Your API requests can be filtered by these values. Not adding any filters to your request will include all data in the results, unfiltered.
Source
Source is the location where your bot may be deployed. For example:
test is source value for conversations by bot builders within the Kindly platform.
web is the source value for Kindly Chat deployed on websites, excluding the Kindly platform.
app is the source value for chats via the Application API﻿.
If you do not filter by sources, all data will be included in the results, including test data.
To select only specific sources, you can send one or more filters like this:
GET https://sage.kindly.ai/api/...&sources[]=web&sources[]=app
You can also select sources to exclude, by prefixing with a minus sign. This means that the API will return data from every source except the ones listed.
GET https://sage.kindly.ai/api/...&sources[]=-test
Language
The language used for chat between the user and the bot is represented by a two-letter language code. If your bot does not use multiple languages, you can safely ignore this parameter.
If you have multiple languages in your bot and you want to filter by language, you can send one or more filters like this:
GET https://sage.kindly.ai/api/...&language_code[]=en&language_code[]=nb
API reference
Most of the APIs can be filtered by time, language, and source. To see what your options are for these filters, you can send a request to the /meta/options API.
/
Filters options - Example request 
View
﻿
Chat sessions
Number of sessions where users engaged with the bot
/
Chat sessions - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
granularity (default: day)
sources[]
language_codes[]
User messages
Number of messages from users
/
User messages - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
granularity (default: day)
sources[]
language_codes[]
Fallback rate time series
Number of- and fraction of bot replies that are fallbacks, as an aggregated time series.
count represents the number of fallback messages in the given time interval, rate represents which fraction of the total number of bot replies in the time interval are fallbacks.
/
Fallback rate time series - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
granularity (default: day)
sources[]
language_codes[]
Fallback rate total
Number of- and fraction of bot replies that are fallbacks, as a total aggregate for the selected time interval.
count represents the number of fallback messages in the given time interval, rate represents which fraction of the total number of bot replies in the time interval are fallbacks.
/
Fallback rate - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
Greeting engagement rate
Shows the rate at which users engage with the bot (messaging or button clicking) after being shown a greeting message.
missed shows the number of sessions where the bot greeted but the user didn't interact
rate is the ratio of engaged chats out of total chats
/
Greeting engagement - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
granularity (default: day)
sources[]
language_codes[]
Engagement rate total
Shows the rate at which users engage with the bot (messaging or button clicking) after being shown a greeting message.
/
Engagement - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
Web client / Kindly Chat pages
Lists most frequent web pages where interactions with the bot have happened. Returns top 3 pages by default, use the limit parameter to request more results.
/
Kindly Chat pages - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
limit (default: 3)
Number of handovers - time series
The number of handover requests (while open), requests while closed, started handovers, and ended handovers in the requested time period, as a time series.
/
Handovers time series - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
granularity (default: day)
sources[]
language_codes[]
Number of handovers - total
The total number of handover requests (while open), requests while closed, started handovers, and ended handovers in the requested time period.
/
Handovers - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
Button clicks
An ordered list of the most clicked buttons in the chatbot, and the dialogues the buttons belong to. Has both a count of the number of occurrences and a ratio of the total amount of button clicks for the period. Returns top 5 results by default. Use the limit parameter to request more data.
/
Button clicks - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
limit (default: 5)
Labels
The most frequent labels added to chats. Returns top 5 labels by default. Use the limit parameter to request more data.
/
Labels - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
limit (default: 5)
Customer feedback
Shows the number of feedbacks in each category (/bot or /handover) for the given time period.
count shows the number of times a particular rating has been given
index is a representation of the ordering of the feedback options shown to the user. 0 is the leftmost option, etc. Most rating systems order the values left to right from worst to best, but this is customizable.
rating is the text description of the given feedback
rating_system is the type of feedback shown
ratio is the number of feedbacks given of this rating out of the total number of feedbacks given
/
Customer feedback - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
Example
This example requires Python 3.6 or higher (uses f-strings) and the package requests.
You will need to provide two values yourself, the relevant bot ID and an API key with "read statistics" permissions that you have created at https://app.kindly.ai/bot/BOT_ID/connect/api-keys. The code exchanges the API key for a JWT, uses the JWT to get data about the number of messages per day for the bot's lifetime, then renders the data as a Unicode box-character bar chart.
Python
from time import sleep
from urllib.parse import urljoin

import requests

BOT_ID: int = REPLACE ME
KINDLY_STATISTICS_API_KEY: str = REPLACE ME  # get this from https://app.kindly.ai/workspace/BOT_ID/connect/api-keys
SAGE_API_ROOT = 'https://sage.kindly.ai/api/v1/'

JWT = None


def get_new_jwt():
    url = f'https://api.kindly.ai/api/v2/bot/{BOT_ID}/sage/auth'
    response = requests.get(url, headers={'Authorization': f'Bearer {KINDLY_STATISTICS_API_KEY}'})
    response.raise_for_status()
    return response.json()['jwt']


def sage_request(endpoint, params=None):
    global JWT

    url = urljoin(SAGE_API_ROOT, f"stats/bot/{BOT_ID}/{endpoint.lstrip('/')}")
    while True:
        if JWT is None:
            JWT = get_new_jwt()

        try:
            response = requests.get(url, params, headers={'Authorization': f'Bearer {JWT}'})
            response.raise_for_status()
        except requests.HTTPError as e:
            if e.response.status_code == 401:
                print('401: fetching new JWT before retrying')
                JWT = None
                continue

            if e.response.status_code == 429:
                wait_time = e.response.headers.get('retry-after', 10)
                print(f'429: rate limited: waiting {wait_time}s before retrying')
                sleep(wait_time)
                continue

            raise

        return response.json()['data']


# First, fetch some metadata about the bot
options = sage_request('/meta/options')

first = options['first']
last = options['last']
granularities = options['granularities']
language_codes = options['language_codes']
sources = options['sources']

# Display the metadata
print(
    f"""
The earliest date with data is: {first}
The latest date with data is: {last}
Granularity options are: {granularities}
Language options are: {language_codes}
Source options are: {sources}
"""
)

# Then, fetch data about the number of messages in the time period
messages = sage_request('/sessions/messages', {'from': first, 'to': last})

highest = max(x['count'] for x in messages)
if highest == 0:
    raise Exception('No data found')


# Display the data about the number of messages in the terminal
def bar_chart(label, n, scale=1):
    """
    make a "sideways bar chart" with Unicode box characters
    """
    width = n // scale
    if n == 0:
        bar = ''
    elif width == 0:
        bar = '▍'
    else:
        bar = '█' * width

    return f"{label}: {bar} {n}"


LINE_WIDTH = 80
c = highest // LINE_WIDTH
print(f'Number of messages between {first} and {last}')
print(*(bar_chart(x['date'].split('T', 2)[0], x['count'], scale=c) for x in messages), sep='\n')

from time import sleep
from urllib.parse import urljoin

import requests

BOT_ID: int = REPLACE ME
KINDLY_STATISTICS_API_KEY: str = REPLACE ME  # get this from https://app.kindly.ai/workspace/BOT_ID/connect/api-keys
SAGE_API_ROOT = 'https://sage.kindly.ai/api/v1/'

JWT = None


def get_new_jwt():
    url = f'https://api.kindly.ai/api/v2/bot/{BOT_ID}/sage/auth'
    response = requests.get(url, headers={'Authorization': f'Bearer {KINDLY_STATISTICS_API_KEY}'})
    response.raise_for_status()
    return response.json()['jwt']


def sage_request(endpoint, params=None):
    global JWT

    url = urljoin(SAGE_API_ROOT, f"stats/bot/{BOT_ID}/{endpoint.lstrip('/')}")
    while True:
        if JWT is None:
            JWT = get_new_jwt()

        try:
            response = requests.get(url, params, headers={'Authorization': f'Bearer {JWT}'})
            response.raise_for_status()
        except requests.HTTPError as e:
            if e.response.status_code == 401:
                print('401: fetching new JWT before retrying')
                JWT = None
                continue

            if e.response.status_code == 429:
                wait_time = e.response.headers.get('retry-after', 10)
                print(f'429: rate limited: waiting {wait_time}s before retrying')
                sleep(wait_time)
                continue

            raise

        return response.json()['data']


# First, fetch some metadata about the bot
options = sage_request('/meta/options')

first = options['first']
last = options['last']
granularities = options['granularities']
language_codes = options['language_codes']
sources = options['sources']

# Display the metadata
print(
    f"""
The earliest date with data is: {first}
The latest date with data is: {last}
Granularity options are: {granularities}
Language options are: {language_codes}
Source options are: {sources}
"""
)

# Then, fetch data about the number of messages in the time period
messages = sage_request('/sessions/messages', {'from': first, 'to': last})

highest = max(x['count'] for x in messages)
if highest == 0:
    raise Exception('No data found')


# Display the data about the number of messages in the terminal
def bar_chart(label, n, scale=1):
    """
    make a "sideways bar chart" with Unicode box characters
    """
    width = n // scale
    if n == 0:
        bar = ''
    elif width == 0:
        bar = '▍'
    else:
        bar = '█' * width

    return f"{label}: {bar} {n}"


LINE_WIDTH = 80
c = highest // LINE_WIDTH
print(f'Number of messages between {first} and {last}')
print(*(bar_chart(x['date'].split('T', 2)[0], x['count'], scale=c) for x in messages), sep='\n')
﻿
Legacy APIs
These APIs are for deprecated features that may be removed in the future, but as long as they remain compatible we keep documentation here.
Chat bubble feedback
If you have enabled the feedback feature in Kindly Chat you can get a summary of the ratings given by users in the period.
The API considers the ratings as numbers, with 1 being the lowest rating.
Both the count of the number of ratings and the ratio of the total number of ratings is given.
This API only returns aggregated data.
If you want to analyze the feedback texts users have given you can get these from an inbox backup.
See also: Inbox backup to GCS bucket﻿.
/
(Legacy) Feedback - Example request
View
﻿
Required parameters
from (YYYY-MM-DD)
to (YYYY-MM-DD)
Optional parameters
tz (default: UTC)
sources[]
language_codes[]
﻿
Nudge API
iOS SDK