Dialog statistics
The statistics analysis platform provides access to daily logs. Users can download the previous day’s logs for the entire account. The logs are provided in the .csv file format.
How can I download dialog logs?
-
The account administrator should contact technical support with a request to activate the dialog log download option. If you use one of the business plans (JAICP Business Standard, JAICP Business Pro, JAICP Business Pro+, JAICP Business Ultra, JAICP Business Enterprise), the option was automatically activated when switching to this plan.
-
After technical support has confirmed that the option has been enabled, the account administrator adds the RAWLOGS_ANALYTIC role to the users that should have permission to download
.csvdialog log files. -
Any user with the role RAWLOGS_ANALYTIC is authorized on the platform and downloads dialog logs to the address:
http(s)://hostname/restapi/rawlogs/dd-mm-yyyy.csv // hostname – the platform address, dd – the day, mm – the month, yyyy – the yearWhen will the logs start to generate?
Note that the upload logs begin to be generated when the option is enabled. Dialog logs generated before the option is enabled are not available for download.
Daily logs are written to a file for the previous day as counted from the start time of the log generation task. By default, logs for the previous day are generated at 00:01 UTC-0. When dialog logs for the same day are generated, the previously saved file is overwritten.
Please note that dialog logs in the Dialogs section are displayed in accordance with the time zone set in the user profile. However, in the exported file the time zone is UTC-0.
I have enabled removal of dialog logs
If the Cleanup dialogs option is active for the account or for a project, then logs older than the specified date will be completely deleted for the entire account, regardless of the project.
Is there another way to download logs?
You can also download the file with a GET request. The download is available only to authenticated users that have the RAWLOGS_ANALYTIC role. You can use basic authentication to authenticate. To do so, in the Headers specify Product:botadmin.
Exported data
| Field | Description | Example |
|---|---|---|
session_id |
session ID | 20a8444a-e1dd-5865-5ee7-b03fcb65e19b.732196de-2de6-455f-b751-e2c9a4700c62 |
session_start_time |
the session start time | 28.01.2019 17:18:45 |
session_end_time |
the session end time | 28.01.2019 21:18:45 |
session_questions_count |
the overall number of phrases in the session | 14 |
session_tag |
the tag of the session | The request has been fulfilled |
channel_type |
the type of the channel | Telegram |
channel_name |
the name of the channel | demo_bot |
client_id |
the user ID | telegram-118460129-demobot-118460129-XLA-160021967-294227430 |
client_name |
the name of the client | John |
project_name |
the name of the project | Demobot |
msg_rt |
the time the phrase was written by the server | 13.02.2019 13:41:12 |
msg_question |
the user request | Find the nearest ATM |
msg_answer |
the bot reply | The nearest ATM is located at the Chkalovskaya subway station |
state_before |
the state before processing the request | /Menu |
state_after |
the state after processing the request | /CatchAll/Switch/NoOperatorsOnline |
msg_switched |
true: a transfer to another operator took place after this request false: no switching occurred |
true |
msg_operator |
true: the operator replied false: the bot replied |
false |
msg_comment |
comment to the phrase | ATM search |
msg_tags |
tags for the phrase | ATMs |