URL Path

A URL (Uniform Resource Locator) path identifies the REST resource that you want to call. A complete URL path consists of the server name and the resource path:

https://<server>/<resource-path>

The <server> is the REST API Server URL mentioned in the welcome email sent to your Oracle B2C Service administrator. For example:

https://mysite.example.com

The <resource-path> is the relative path or endpoint to the resource you're working with. For example, for metric data, the resource path is as follows:

/AgentWeb/api/analyticsmanager/serviceUsageMetrics/metricData

So, the combined request URL for the accounts resource becomes:

https://mysite.example.com/AgentWeb/api/analyticsmanager/serviceUsageMetrics/metricData

URL Syntax:

Access the Oracle B2C Service: Service Usage Metrics REST APIs using the following URL syntax:

https://your_site_interface/AgentWeb/api/analyticsmanager/module/resource[/resource_id][?query_parameters]

The following table describes the URL syntax.

Parameter Description

your_site_interface

The domain name of your interface, such as mysite.example.com.

module

The name of the module, for example, serviceUsageMetrics.

resource

The name of the resource, for example, metricData.

resource_id

The primary identifier of the resource. For example, NamedUsers.

query_parameters

The query parameters where allowed, for example, startDate.

For example:

https://mysite.example.com/AgentWeb/api/analyticsmanager/serviceUsageMetrics/metricData/NamedUsers?startDate=2024-01-20T00%3A00%3A00&format=JSON