Answer Insights API

This API initiates the export of answer insights data to a file in JSON format. You can apply filters to export specific results.

Currently, this API can export Analytics data for up to one week at most. If you need to download data for a longer period, you'll need to invoke the API multiple times. For example, to obtain data for an entire month, you would call the API four times, once for each week of that month.

To download the analytics data as a file, follow these steps:

1. Use the provided API to initiate an export job. This will create a job of type DATA_EXPORT.
2. After initiating the job, use the jobs API to retrieve the details of the exported file. Be sure to pass the job ID of the job you just created.
3. Please note that the file URL will only be generated after the job has been successfully completed.
4. Once you have the file URL, you can open or download it through your web browser.

Method	POST
Endpoint	<host_url>/api/public/bot/<AppID>/search/analytics-export
Content-Type	application/json
Authorization	auth: <JWT Token>
API Scope	Answer Insights

Query Parameters

Parameters	Description	Mandatory
AppID	Provide your application ID here.	Yes

Request Parameters

Parameters	Description	Mandatory
Filter	Currently, it takes the following two parameters: to: date and time in UTC from: date and time in UTC \ Examples: When only dates are used to filter the data. "filters": { "from": "2025-01-25", "to": "2025-01-31” } When a specific time is also to be included, ensure it follows the ISO 8601 format, like "filters": { "from": "2025-01-25T07:32:58.611Z", "to": "2025-01-31T07:32:58.611Z" }	Yes
event	This field can take the following values: thumbsUp thumbsDown If an event is provided, only the corresponding data is exported for the selected duration. For instance, if the event is set to thumbsUp, only the data with positive feedback is exported. Note that the event values are case-sensitive.	No

Sample Request

{
"filters": {
"from": "2025-01-25T07:32:58.611Z",
"to": "2025-01-31T07:32:58.611Z"
}
}

Response

The API returns a job ID(_id). The job type is set to DATA_EXPORT. The fileInfo object in the response gives information about the type of file being generated. Use the job id to get the file details.

Sample Response - Creating Export Job

{
    "_id": "fj-2618a702-0211-50ca-8504-c1ac377a2402",
    "hidden": false,
    "read": false,
    "status": "INPROGRESS",
    "percentageDone": 0,
    "title": "Exporting Analytics Data - JSON",
    "message": "Exporting Analytics Data - JSON",
    "lMod": "2025-06-30T06:51:12.000Z",
    "startedAt": "2025-06-30T06:51:12.138Z",
    "timedOut": false,
    "jobType": "DATA_EXPORT",
    "streamId": "st-1715923c-9a58-54e7-aaa7-14920ded9b91",
    "searchIndexId": "sidx-05d139f8-abca-50ec-84f5-2f29855aba5b",
    "fileInfo": {
        "ext": "json"
    },
    "createdBy": "u-4d04030a-93f3-5cba-a07b-1a5b20a7e9a9",
    "directoryInfo": null,
    "opType": "Manual",
    "extractionSourceId": null,
    "contentId": null,
    "error": null,
    "parentJobId": null,
    "createdOn": "2025-06-30T06:51:12.140Z",
    "__v": 0
}

When invoking the jobs API for file export, the response contains a fileInfo field that includes the link to the exported file with answer insights.

Response - Jobs API

{
    "_id": "fj-2618a702-0211-50ca-8504-c1ac377a2402",
    "hidden": false,
    "read": false,
    "status": "SUCCESS",
    "percentageDone": 100,
    "title": "Exporting Analytics Data - JSON",
    "message": "ANALYTICS DATA JSON Export Completed - 1 file(s) with 9 total records",
    "lMod": "2025-06-30T06:51:12.000Z",
    "startedAt": "2025-06-30T06:51:12.138Z",
    "timedOut": false,
    "jobType": "DATA_EXPORT",
    "streamId": "st-1715923c-9a58-54e7-aaa7-14920ded9b91",
    "searchIndexId": "sidx-05d139f8-abca-50ec-84f5-2f29855aba5b",
    "fileInfo": {
        "fileId": "686233e0a4bca53b7f61c074",
        "fileName": "analytics_data_1751266272195",
        "fileUrl": "https://staging-xo.korebots.com/api/getMediaStream/findly/f-54847fe6-4c20-5a64-9a6d-b4b82afba169.json?n=7691453184&s=Ik9nanpJclk0dUsyVjA2bXB6OFNDOXdOWjdRQ3NxTDJjWXFnT0NPOWRqLzQ9Ig$$"
    },
    "createdBy": "u-4d04030a-93f3-5cba-a07b-1a5b20a7e9a9",
    "directoryInfo": null,
    "opType": "Manual",
    "extractionSourceId": null,
    "contentId": null,
    "error": null,
    "parentJobId": null,
    "createdOn": "2025-06-30T06:51:12.140Z",
    "__v": 0,
    "analyticsFragments": [
        {
            "fileId": "686233e0a4bca53b7f61c074",
            "fileName": "analytics_data_1751266272195",
            "fileUrl": "https://staging-xo.korebots.com/api/getMediaStream/findly/f-54847fe6-4c20-5a64-9a6d-b4b82afba169.json?n=7691453184&s=Ik9nanpJclk0dUsyVjA2bXB6OFNDOXdOWjdRQ3NxTDJjWXFnT0NPOWRqLzQ9Ig$$",
            "recordCount": 9
        }
    ],
    "hasAnalyticsFragments": false,
    "store": {
        "urlParams": "&clientfilename=analytics_data_1751266272341.json&batchtesting=true",
        "totalFiles": 1,
        "totalRecords": 9
    }
}

Refer to the fileInfo field in the response to get details of the exported file. The file can be downloaded from the fileURL in this field. The exported file contains the analytics data for the selected time frame in JSON format. It includes the details of the search query, generated answer along with the debug information including the relevant chunks, llm request and response parameters.

Note that this is only used for small files (less than 150 records.) For larger datasets, the data is divided into smaller fragments of 150 records each, and each fragment is available as a separate file. Refer below for more details. The export API gives the job ID for the corresponding job and the job status api returns the list of files as fragments.

Exported JSON file Sample

Here is a sample of the exported JSON file containing analytics data. Actual output may vary based on your specific Search AI app configuration.

Exporting Analytics Data for Large Datasets

When exporting analytics data for a large dataset within a specified date range, it is important to note that the dataset may be segmented into multiple fragments. Each fragment will be available as a separate downloadable file, with a default limit of 150 records per file.

In addition to the usual export job details, the export job will include the following additional information in the response regarding these fragments, allowing you to efficiently manage and download the complete dataset.

Field	Type	Description
hasAnalyticsFragments	Boolean	Indicates if the export is split into multiple files. true for multi-file exports false for single-file exports
analyticsFragments	Array	Required: Contains metadata about all export fragments/files. Present for both single and multi-file exports
store	Object	Provide Meta info, totalRecords & totalFiles
percentageDone	number	Percentage-based status for analytics export progress

Sample response - Jobs API for a large dataset with multiple fragments

{
    "_id": "fj-4ccf7101-baf1-5729-9347-60deba1113c9",
    "hidden": false,
    "read": false,
    "status": "SUCCESS",
    "percentageDone": 100,
    "title": "Exporting Analytics Data - JSON",
    "message": "ANALYTICS DATA JSON Export Completed - 3 file(s) with 400 total records",
    "lMod": "2025-06-10T13:55:09.000Z",
    "startedAt": "2025-06-10T13:54:38.953Z",
    "timedOut": false,
    "jobType": "DATA_EXPORT",
    "streamId": "st-8963e59e-f160-581d-a8f9-3b7d971b0a53",
    "searchIndexId": "sidx-a222bbd9-da7b-5689-88f9-3f9958511d1b",
    "hasAnalyticsFragments": true,
    "fileInfo": {},
    "createdBy": "u-e3c6ebfa-e56f-56d4-9870-6a5ce414aaf3",
    "directoryInfo": null,
    "opType": "Manual",
    "extractionSourceId": null,
    "contentId": null,
    "error": null,
    "parentJobId": null,
    "createdOn": "2025-06-10T13:54:38.954Z",
    "__v": 0,
    "analyticsFragments": [
        {
            "fileId": "6848391f171ddc36802e20db",
            "fileName": "analytics_data_1749563679586_part_1_of_3",
            "fileUrl": "https://qa1-uxo.kore.ai:443/api/getMediaStream/findly/f-77fd8d06-da12-5414-9a32-bfb1cd0251fd.json?n=526269727&s=IlpVUjN2aDJHY2RGVTdYaVZIRjVyeWdOWEJxbXZZd1ducmw1NHJ4V1JBeHc9Ig$$",
            "recordCount": 150
        },
        {
            "fileId": "68483929171ddc36802e216b",
            "fileName": "analytics_data_1749563689734_part_2_of_3",
            "fileUrl": "https://qa1-uxo.kore.ai:443/api/getMediaStream/findly/f-8139e91f-b30d-5dc8-af13-127668808d0b.json?n=3627398285&s=IndRVG14ejNyK2RNM0tBUXNScUV4Z2ZQZG9ZUnFxSGpwSGUyLzIrcE96Wk09Ig$$",
            "recordCount": 150
        },
        {
            "fileId": "68483933171ddc36802e2192",
            "fileName": "analytics_data_1749563699827_part_3_of_3",
            "fileUrl": "https://qa1-uxo.kore.ai:443/api/getMediaStream/findly/f-90b89e64-232b-5e6b-9a1e-6be8b462cedd.json?n=4384938178&s=IlZyOW9kWnh3OThNQ1NxL2RGdVFtNXJFU3E4K0h2U1RwRHQ3amltYmI0TkU9Ig$$",
            "recordCount": 100
        }
    ],
    "store": {
        "urlParams": "&clientfilename=analytics_data_1749563709906.json&batchtesting=true",
        "totalFiles": 3,
        "totalRecords": 400
    }
}

Points to Note

• Always check the hasAnalyticsFragments field to determine if data is segmented.
• Ensure your date ranges are within 7 days.
• Use ISO 8601 format for from and to timestamps.
• Data is exported in JSON format.

Send Feedback