/AWS1/IF_LM2=>LISTSESSIONANALYTICSDATA()

About ListSessionAnalyticsData

Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Method Signature

METHODS /AWS1/IF_LM2~LISTSESSIONANALYTICSDATA
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IV_STARTDATETIME TYPE /AWS1/LM2TIMESTAMP OPTIONAL
    !IV_ENDDATETIME TYPE /AWS1/LM2TIMESTAMP OPTIONAL
    !IO_SORTBY TYPE REF TO /AWS1/CL_LM2SESSIONDATASORTBY OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_LM2ALYSSESSIONFILTER=>TT_ANALYTICSSESSIONFILTERS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2MAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2lstsessalysdatarsp
  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 session analytics.

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 session analytics.

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 session analytics.

Optional arguments:

io_sortby TYPE REF TO /AWS1/CL_LM2SESSIONDATASORTBY /AWS1/CL_LM2SESSIONDATASORTBY

An object specifying the measure and method by which to sort the session analytics data.

it_filters TYPE /AWS1/CL_LM2ALYSSESSIONFILTER=>TT_ANALYTICSSESSIONFILTERS TT_ANALYTICSSESSIONFILTERS

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

iv_maxresults TYPE /AWS1/LM2MAXRESULTS /AWS1/LM2MAXRESULTS

The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

iv_nexttoken TYPE /AWS1/LM2NEXTTOKEN /AWS1/LM2NEXTTOKEN

If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.

RETURNING

oo_output TYPE REF TO /aws1/cl_lm2lstsessalysdatarsp /AWS1/CL_LM2LSTSESSALYSDATARSP

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->listsessionanalyticsdata(
  io_sortby = new /aws1/cl_lm2sessiondatasortby(
    iv_name = |string|
    iv_order = |string|
  )
  it_filters = VALUE /aws1/cl_lm2alyssessionfilter=>tt_analyticssessionfilters(
    (
      new /aws1/cl_lm2alyssessionfilter(
        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_maxresults = 123
  iv_nexttoken = |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.
  lv_id = lo_result->get_botid( ).
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_sessions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_botaliasid = lo_row_1->get_botaliasid( ).
      lv_numericalbotversion = lo_row_1->get_botversion( ).
      lv_localeid = lo_row_1->get_localeid( ).
      lv_analyticschannel = lo_row_1->get_channel( ).
      lv_analyticssessionid = lo_row_1->get_sessionid( ).
      lv_timestamp = lo_row_1->get_conversationstarttime( ).
      lv_timestamp = lo_row_1->get_conversationendtime( ).
      lv_analyticslongvalue = lo_row_1->get_conversationdurseconds( ).
      lv_conversationendstate = lo_row_1->get_conversationendstate( ).
      lv_analyticsmodality = lo_row_1->get_mode( ).
      lv_analyticslongvalue = lo_row_1->get_numberofturns( ).
      LOOP AT lo_row_1->get_invokedintentsamples( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_name = lo_row_3->get_intentname( ).
        ENDIF.
      ENDLOOP.
      lv_analyticsoriginatingreq = lo_row_1->get_originatingrequestid( ).
    ENDIF.
  ENDLOOP.
ENDIF.