/AWS1/CL_PPT=>GETJOURNEYRUNEXECMETRICS()

About GetJourneyRunExecutionMetrics

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.

Method Signature

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

iv_journeyid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The unique identifier for the journey.

iv_runid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The unique identifier for the journey run.

Optional arguments:

iv_nexttoken TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

iv_pagesize TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

RETURNING

oo_output TYPE REF TO /aws1/cl_pptgetjourneyrunexm01 /AWS1/CL_PPTGETJOURNEYRUNEXM01

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->/aws1/if_ppt~getjourneyrunexecmetrics(
  iv_applicationid = |string|
  iv_journeyid = |string|
  iv_nexttoken = |string|
  iv_pagesize = |string|
  iv_runid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_journeyrunexecutionmetr = lo_result->get_journeyrunexecmetricsrsp( ).
  IF lo_journeyrunexecutionmetr IS NOT INITIAL.
    lv___string = lo_journeyrunexecutionmetr->get_applicationid( ).
    lv___string = lo_journeyrunexecutionmetr->get_journeyid( ).
    lv___string = lo_journeyrunexecutionmetr->get_lastevaluatedtime( ).
    LOOP AT lo_journeyrunexecutionmetr->get_metrics( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv___string = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv___string = lo_journeyrunexecutionmetr->get_runid( ).
  ENDIF.
ENDIF.

To get the execution metrics for a journey run

The following example gets execution metrics for a single run of a journey.

DATA(lo_result) = lo_client->/aws1/if_ppt~getjourneyrunexecmetrics(
  iv_applicationid = |11111111112222222222333333333344|
  iv_journeyid = |aaaaaaaaaabbbbbbbbbbccccccccccdd|
  iv_runid = |99999999998888888888777777777766|
).