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://monitoring.custhelp.com
The <resource-path>
is the
relative path or endpoint to the resource you're working
with. For example, for error metric data, the resource path is as follows:
/v1/errormetrics
So, the combined request URL for the sitemetrics resource becomes:
https://monitoring.custhelp.com/v1/errormetrics
URL Syntax:
Access the Oracle B2C Service: Service Health Metrics REST APIs using the following URL syntax:
https://your_site_interface/v1/module/resource[/resource_id][/child_resource][/child_resource_id][?query_parameters]
The following table describes the URL syntax.
Parameter | Description |
---|---|
your_site_interface |
The domain name of your interface, such as monitoring.custhelp.com. |
module | The name of the module, such as errormetrics. |
resource | The name of the resource, such as 4XX. |
child_resource | The name of the child resource, such as webserver. |
query_parameters | The query parameters where allowed. |
For example:
https://monitoring.custhelp.com/v1/errormetrics/4XX/webserver