Jump to

• Request
• Response

Get engagement level metrics of an object

get

/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/engagementLevel

This method is used get the engagement level metrics of an Sales object.

Request

Query Parameters

• q: string
  To identify: A CRM object by ObjectType value. Example: ObjectType=opportunity

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

Type: object

Title: MetricsEngagementLevelResponse

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 engagement level metric items.
• limit: integer
  The limit applied to the query.
• links: array links
  The links.
• offset: integer
  The offset applied to the query.

{
    "title":"MetricsEngagementLevelResponse",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The engagement level 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 engagement level metric items.

Show Source

• Array of: object metricItems
  Title: metricItems

  The metric items.

{
    "type":"array",
    "description":"The engagement level 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