eCommerce Interaction Metrics REST API

Overview

This section describes the eCommerce Interaction Metrics REST API, which is available for REST version 6 or later by all Host Company Full Access users. The REST response returns data for all interactions performed between the start and end dates passed in the request. If a start and end date are not included in the request, all records are returned.

Each time an eCommerce partner (e.g. CX Commerce) loads CPQ configuration in an iFrame, it will count as an interaction. This will occur for the following situations:

If an eCommerce partner renders their own UI by making calls to our Configuration REST APIs, rather than loading our UI directly through the iFrame, eCommerce Interaction Metrics will count interactions from the configure and reconfigure REST API calls for the following situations:

Administration

Closed eCommerce Interaction Metrics

  eCommerce Interaction Metrics GET Method
Description Retrieves eCommerce usage metrics.
URI Endpoint

/rest/v17/ecommerceInteractionMetrics
Endpoint Parameters

This endpoint supports query specifications that follow Oracle CPQ query and pagination parameters syntax. Query specifications follow a subset of MongoDB syntax and can be used to organize or narrow return data. For more information, see Manage Collections.
HTTP Method GET

Request Body Parameters

None
Response Body Parameters

 

 

 

id

 Primary Key of the interaction metrics resource.

timestamp

Timestamp for eCommerce interaction

interaction

eCommerce interaction type - (configure or reconfigure)

login

Login of the user who performed the eCommerce interaction

ClosedURI Endpoint Sample

https://sitename.bigmachines.com/rest/v17/ecommerceInteractionMetrics

ClosedResponse Sample

{ "hasMore": true, "items": [{ "id": 21754096, "timestamp": "2018-02-28T21:59:16.000Z", "interaction": "configure", "login": "SuperUser", "links": [{ ... } ] }, { "id": 21754100, "timestamp": "2018-02-28T21:59:16.000Z", "interaction": "configure", "login": "guest", "links": [{ ... } ] }, { "id": 21754104, "timestamp": "2018-02-28T21:59:17.000Z", "interaction": "configure", "login": "guest", "links": [{ ... } ] } }

ClosedAccess the eCommerce Interaction Metrics REST API from the Interface Catalog

Administrators can access metadata for the eCommerce Interaction Metrics REST API from the Interface Catalogs page.

To access the metadata, perform the following steps:

  1. Open the Admin Home page.

  2. Under Integration Platform, select Interface Catalogs.
    The Interface Catalogs page opens.

  3. Click “ecommerceInteractionMetrics” to view metadata for the “eCommerce Interaction Metrics” REST API.

    Interface Catalog

Related Topics

Related Topics Link IconSee Also