Jump to

• Request
• Response
• Examples

Get activity effectiveness metrics of an object

get

/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/activityEffectiveness

This method is used to get the activity effectiveness metrics of an object.

Request

Query Parameters

• q: string
  To identify: A Sales object by ObjectType value. Example: ObjectType=lead

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 : MetricsActivityEffectivenessResponse

Type: object

Title: MetricsActivityEffectivenessResponse

Show Source

• count: integer
  The count of items in current response.
• hasMore: boolean
  A boolean flag which indicates the availability of more matching records at server.
• items: array items
  The activity effectiveness metric items.
• limit: integer
  The limit applied to the query.
• links: array links
  The links.
• offset: integer
  The offset applied to the query.

{
    "title":"MetricsActivityEffectivenessResponse",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The activity effectiveness metric items.",
            "items":{
                "$ref":"#/components/schemas/MetricItems"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset applied to the query."
        },
        "limit":{
            "type":"integer",
            "description":"The limit applied to the query."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean flag which indicates the availability of more matching records at server."
        },
        "count":{
            "type":"integer",
            "description":"The count of items in current response."
        },
        "links":{
            "type":"array",
            "description":"The links.",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

The activity effectiveness metric items.

Show Source

• Array of: object metricItems
  Title: metricItems

  The metric items.

{
    "type":"array",
    "description":"The activity effectiveness metric items.",
    "items":{
        "$ref":"#/components/schemas/MetricItems"
    }
}

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 : metricItems

Type: object

Title: metricItems

The metric items.

Show Source

• CreatedBy: string
  Indicates the user who created the row.
• CreationDate: string (date-time)
  Indicates the date and time of the creation of the row.
• InsightMetricId: integer
  The auto-generated unique Identifier for an insight metric.
• InsightTemplateUuid: string (uuid)
  The auto-generated unique Identifier for an insight template
• InsightTypeCode: string
  A unique code assigned to an insight template.
• LastUpdateDate: string (date-time)
  Indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Indicates the session login associated to the user who last updated the row.
• ObjectMetrics: object ObjectMetrics
  The object level metrics generated by executing object query templates.

{
    "title":"metricItems",
    "type":"object",
    "properties":{
        "InsightMetricId":{
            "type":"integer",
            "description":"The auto-generated unique Identifier for an insight metric."
        },
        "InsightTypeCode":{
            "type":"string",
            "description":"A unique code assigned to an insight template."
        },
        "LastUpdatedBy":{
            "type":"string",
            "description":"Indicates the user who last updated the row."
        },
        "LastUpdateLogin":{
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row."
        },
        "InsightTemplateUuid":{
            "type":"string",
            "description":"The auto-generated unique Identifier for an insight template",
            "format":"uuid"
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time"
        },
        "CreatedBy":{
            "type":"string",
            "description":"Indicates the user who created the row."
        },
        "ObjectMetrics":{
            "type":"object",
            "properties":{
            },
            "description":"The object level metrics generated by executing object query templates."
        }
    },
    "description":"The metric items."
}

Nested Schema : ObjectMetrics

Type: object

The object level metrics generated by executing object query templates.

Show Source

{
    "type":"object",
    "properties":{
    },
    "description":"The object level metrics generated by executing object query templates."
}

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 activity effectiveness 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/crmSalesIntelligenceApi/latest/metrics/activityEffectiveness

Example of Response Body

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

{
    "items": [
        {
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "InsightTypeCode": "CONTACT_VALIDATION",
            "ObjectType": "lead",
            "LastUpdateDate": "2021-09-03T06:17:30+00:00",
            "LastUpdateLogin": "CB1108382C103F98E053AC0AF50A3382",
            "InsightTemplateUuid": "336d82a2-a707-4564-b618-63db01263aab",
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ObjectMetrics": {},
            "CreationDate": "2021-09-03T05:53:34+00:00",
            "InsightMetricId": 100100298114812
        },
        {
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "InsightTypeCode": "ACTIVITY_EFFECTIVENESS",
            "ObjectType": "opportunity",
            "LastUpdateDate": "2021-09-03T06:17:30+00:00",
            "LastUpdateLogin": "CB1108382C103F98E053AC0AF50A3382",
            "InsightTemplateUuid": "6b178a58-ddfd-11ea-87d0-0242ac130003",
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ObjectMetrics": {
                "COMMON_ACTIVITY_EFFECTIVENESS": {
                    "ITEMS": []
                }
            },
            "CreationDate": "2021-09-03T05:53:35+00:00",
            "InsightMetricId": 100100298114813
        },
        {
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "InsightTypeCode": "CONTACT_RECOMMENDATION",
            "ObjectType": "opportunity",
            "LastUpdateDate": "2021-09-03T06:17:30+00:00",
            "LastUpdateLogin": "CB1108382C103F98E053AC0AF50A3382",
            "InsightTemplateUuid": "6d442e88-4e53-424a-b0ff-6f4c25c0e687",
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ObjectMetrics": {},
            "CreationDate": "2021-09-03T05:53:35+00:00",
            "InsightMetricId": 100100298114814
        },
        {
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "InsightTypeCode": "CONTACT_VALIDATION",
            "ObjectType": "opportunity",
            "LastUpdateDate": "2021-09-03T06:17:30+00:00",
            "LastUpdateLogin": "CB1108382C103F98E053AC0AF50A3382",
            "InsightTemplateUuid": "925e39d3-e19f-4acd-be76-4dd1212cf369",
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ObjectMetrics": {},
            "CreationDate": "2021-09-03T05:53:35+00:00",
            "InsightMetricId": 100100298114815
        },
        {
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "InsightTypeCode": "CONTACT_RECOMMENDATION",
            "ObjectType": "lead",
            "LastUpdateDate": "2021-09-03T06:17:30+00:00",
            "LastUpdateLogin": "CB1108382C103F98E053AC0AF50A3382",
            "InsightTemplateUuid": "cc8a09fc-fe32-4a7e-b886-b2e48b7b00ec",
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ObjectMetrics": {},
            "CreationDate": "2021-09-03T05:53:35+00:00",
            "InsightMetricId": 100100298114816
        },
        {
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "InsightTypeCode": "ACTIVITY_EFFECTIVENESS",
            "ObjectType": "lead",
            "LastUpdateDate": "2021-09-03T06:17:31+00:00",
            "LastUpdateLogin": "CB1108382C103F98E053AC0AF50A3382",
            "InsightTemplateUuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ObjectMetrics": {
                "COMMON_ACTIVITY_EFFECTIVENESS": {
                    "QUALIFIED": {
                        "ITEMS": [
                            {
                                "TOTAL_LEADS": 76,
                                "LEAD_STATUS": "QUALIFIED",
                                "TOTAL_ACTIVITIES": 1,
                                "AVERAGE_ACTIVITIES": null
                            }
                        ]
                    },
                    "UNQUALIFIED": {
                        "ITEMS": [
                            {
                                "TOTAL_LEADS": 76,
                                "LEAD_STATUS": "UNQUALIFIED",
                                "TOTAL_ACTIVITIES": 0,
                                "AVERAGE_ACTIVITIES": null
                            }
                        ]
                    },
                    "ITEMS": null
                }
            },
            "CreationDate": "2021-09-03T05:53:35+00:00",
            "InsightMetricId": 100100298114817
        },
        {
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "InsightTypeCode": "ENGAGEMENT_LEVEL",
            "ObjectType": "account",
            "LastUpdateDate": "2021-09-03T06:17:31+00:00",
            "LastUpdateLogin": "CB1108382C103F98E053AC0AF50A3382",
            "InsightTemplateUuid": "f290f1ee-6c54-4b01-90e6-d701748f0871",
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ObjectMetrics": {
                "COMMON_SALES_CYCLE_ACCOUNT_ENGAGEMENT_LEVEL": {
                    "ITEMS": [
                        {
                            "SALES_CYCLE_TYPE": "common",
                            "SALES_CYCLE": null
                        }
                    ]
                }
            },
            "CreationDate": "2021-09-03T05:53:35+00:00",
            "InsightMetricId": 100100298114818
        }
    ],
    "offset": 0,
    "limit": 25,
    "hasMore": false,
    "count": 7,
    "links": [
        {
            "name": "self",
            "kind": "collection",
            "href": " https://servername.fa.us2.oraclecloud.com/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/activityEffectiveness",
            "rel": "self"
        }
    ]
}

Back to Top