LISTINTENTPATHS()`¶

About ListIntentPaths¶

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:

startDateTime and endDateTime – Define a time range for which you want to retrieve results.
intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order.

Use the optional filters field to filter the results.

Method Signature¶

METHODS /AWS1/IF_LM2~LISTINTENTPATHS
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IV_STARTDATETIME TYPE /AWS1/LM2TIMESTAMP OPTIONAL
    !IV_ENDDATETIME TYPE /AWS1/LM2TIMESTAMP OPTIONAL
    !IV_INTENTPATH TYPE /AWS1/LM2ANALYTICSPATH OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_LM2ALYSPATHFILTER=>TT_ANALYTICSPATHFILTERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2listintentpathsrsp
  RAISING
    /AWS1/CX_LM2INTERNALSERVEREX
    /AWS1/CX_LM2PRECONDFAILEDEX
    /AWS1/CX_LM2SERVICEQUOTAEXCDEX
    /AWS1/CX_LM2THROTTLINGEX
    /AWS1/CX_LM2VALIDATIONEX
    /AWS1/CX_LM2CLIENTEXC
    /AWS1/CX_LM2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_botid` `TYPE /AWS1/LM2ID` `/AWS1/LM2ID`¶

The identifier for the bot for which you want to retrieve intent path metrics.

`iv_startdatetime` `TYPE /AWS1/LM2TIMESTAMP` `/AWS1/LM2TIMESTAMP`¶

The date and time that marks the beginning of the range of time for which you want to see intent path metrics.

`iv_enddatetime` `TYPE /AWS1/LM2TIMESTAMP` `/AWS1/LM2TIMESTAMP`¶

The date and time that marks the end of the range of time for which you want to see intent path metrics.

`iv_intentpath` `TYPE /AWS1/LM2ANALYTICSPATH` `/AWS1/LM2ANALYTICSPATH`¶

The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:

/BookCar

/BookCar/BookHotel

/BookHotel/BookCar

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_LM2ALYSPATHFILTER=>TT_ANALYTICSPATHFILTERS` `TT_ANALYTICSPATHFILTERS`¶

A list of objects, each describes a condition by which you want to filter the results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lm2listintentpathsrsp` `/AWS1/CL_LM2LISTINTENTPATHSRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listintentpaths(
  it_filters = VALUE /aws1/cl_lm2alyspathfilter=>tt_analyticspathfilters(
    (
      new /aws1/cl_lm2alyspathfilter(
        it_values = VALUE /aws1/cl_lm2alysfiltervalues_w=>tt_analyticsfiltervalues(
          ( new /aws1/cl_lm2alysfiltervalues_w( |string| ) )
        )
        iv_name = |string|
        iv_operator = |string|
      )
    )
  )
  iv_botid = |string|
  iv_enddatetime = '20150101000000.0000000'
  iv_intentpath = |string|
  iv_startdatetime = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_nodesummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_name = lo_row_1->get_intentname( ).
      lv_analyticspath = lo_row_1->get_intentpath( ).
      lv_analyticsnodecount = lo_row_1->get_intentcount( ).
      lv_analyticsnodelevel = lo_row_1->get_intentlevel( ).
      lv_analyticsnodetype = lo_row_1->get_nodetype( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_LM2=>LISTINTENTPATHS()¶