Overview

There are two external Model Tester APIs for exporting test reports:

• Test Reports: Use this API to retrieve the domain IDs and associated test report names for the domains in a specific account. This information is then used when calling the Export Test Report API.
• Export Test Report: Use this API to retrieve CSV files for all the test reports for a domain ID, or to retrieve a CSV file for a specific test report.

These APIs let you automate test report retrieval. You can call these APIs, and then use the data from the Export Test Report API to run statistical functions that benchmark the performance of your bot’s NLU model.

Getting started

Here are a few things you'll need to get started with these APIs:

1. Retrieve your domain. Use the LivePerson Domain API to retrieve this information by providing the following service name:

   • Read only: accountConfigReadOnly
   • Read/Write: accountConfigReadWrite

2. Note the API terms of use.

Requirements

• A permanent token provided by LivePerson. Contact your LivePerson representative (other contact options: chat with us on this page, or message Support) to obtain this.
• Your account (brand) ID in Conversational Cloud.

To integrate a second account using these APIs, you must obtain a different permanent token. Each token is valid for only one account.

Test Reports API

Use this API to retrieve the domain IDs and associated test report names for the domains in a specific account. This information is then used when calling the Export Test Report API.

Request

Request headers

Path and query parameters

All path and query parameters must be URL-encoded.

Example

curl -L -X GET 'https://<region>.bc-nlu.liveperson.net/platform/external/api/model_tester/accounts/<le_account_id>/test_reports?domain_name=hii%20test%20v2' -H 'Authorization: <token>' -H 'Accept: application/json'

Response

Response codes

Response body

{
   "success": true,
   "successResult": {
       "domain_test_reports": {
           "hii test v2": [
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "1900"
               },
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "1900-1"
               },
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "1900-2"
               },
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "1900-3"
               },
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "1900-nlu-client"
               },
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "1900-nlu-client-fixed"
               },
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "1950 test cases"
               },
               {
                   "domainId": "39301012-0c7e-4727-bc37-67b30561f8d5",
                   "domainName": "hii test v2",
                   "testReportName": "8"
               }
           ]
       }
   },
   "message": "Success"
}

Troubleshooting

Typically, the automation for your use case should always use the domain_name query parameter to filter the results by domain name. However, to troubleshoot, you can remove it and “work backwards” to identify the issue:

1. Remove the domain_name query parameter.
2. Call this API and retrieve the test report name for the report you want.
3. Retest the second API (Export Test Report), making sure to URL encode the path and query parameters.

Export Test Report API

Use this API to retrieve CSV files for all the test reports for a domain ID, or to retrieve a CSV file for a specific test report.

Request

Request headers

Path and query parameters

All path and query parameters must be URL-encoded.

Example

curl -L -X GET 'https://<region>.bc-nlu.liveperson.net/platform/external/api/model_tester/accounts/<le_account_id>/domains/39301012-0c7e-4727-bc37-67b30561f8d5/export_test_report?report_name=1900' -H 'Authorization: <token>’ -H 'Accept: text/csv'

Response

Response codes

Response body

The response is a CSV file.