Jump to

• Request
• Response
• Examples

Get links to access the enabled insight type metrices

get

/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics

This method is used to get a list the links to access the enabled insight type metrices.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Security

• BasicAuthentication: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Headers

• Server-Time-In-Millis:
  The server time comnsumed by the API to complete execution.

Body ()

Root Schema : BaseResponse

Type: object

Title: BaseResponse

The base response object for facts and metrics APIs.

Show Source

• links: array links
  The links
• rangeSize: integer
  Response items range size
• version: string
  API version

{
    "title":"BaseResponse",
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"API version"
        },
        "rangeSize":{
            "type":"integer",
            "description":"Response items range size"
        },
        "links":{
            "type":"array",
            "description":"The links",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"The base response object for facts and metrics APIs."
}

Nested Schema : links

Type: array

The links

Show Source

• Array of: object Link
  Title: Link

  The link item.

{
    "type":"array",
    "description":"The links",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Title: Link

The link item.

Show Source

• href: string
  The link href.
• kind: string
  The link kind.
• name: string
  The link name.
• rel: string
  The link relation.

{
    "title":"Link",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The link name."
        },
        "kind":{
            "type":"string",
            "description":"The link kind."
        },
        "href":{
            "type":"string",
            "description":"The link href."
        },
        "rel":{
            "type":"string",
            "description":"The link relation."
        }
    },
    "description":"The link item."
}

400 Response

Bad Request

401 Response

Unauthorized

404 Response

Not Found

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to get metrics by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/crmSalesIntelligenceApi/latest/metrics

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "version": "11.13.18.05",
    "rangeSize": 25,
    "links": [
        {
            "name": "canonical",
            "kind": "item",
            "href": " https://servername.fa.us2.oraclecloud.com/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics",
            "rel": "canonical"
        },
        {
            "name": "self",
            "kind": "item",
            "href": " https://servername.fa.us2.oraclecloud.com/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics",
            "rel": "self"
        },
        {
            "name": "activityEffectiveness",
            "kind": "collection",
            "href": " https://servername.fa.us2.oraclecloud.com/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/activityEffectiveness",
            "rel": "child"
        },
        {
            "name": "contactRecommendation",
            "kind": "collection",
            "href": " https://servername.fa.us2.oraclecloud.com/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/contactRecommendation",
            "rel": "child"
        },
        {
            "name": "engagementLevel",
            "kind": "collection",
            "href": " https://servername.fa.us2.oraclecloud.com/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/engagementLevel",
            "rel": "child"
        },
        {
            "name": "contactValidation",
            "kind": "collection",
            "href": " https://servername.fa.us2.oraclecloud.com/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/contactValidation",
            "rel": "child"
        }
    ]
}

Back to Top