Jump to

• Request
• Response

Get facts about the engagement level

get

/crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts/engagementLevel

This method is used get the record level facts about the engagement level of a record.

Request

Query Parameters

• q: string
  To identify: A CRM object record by ObjectType and ObjectId values. Example: ObjectType=account;ObjectId=999999999

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

Type: object

Title: EngagementLevelFacts

The engagementLevel API response.

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

{
    "title":"EngagementLevelFacts",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The engagement level fact items.",
            "items":{
                "$ref":"#/components/schemas/EngagementLevelFactItems"
            }
        },
        "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"
            }
        }
    },
    "description":"The engagementLevel API response."
}

Nested Schema : items

Type: array

The engagement level fact items.

Show Source

• Array of: object EngagementLevelFactItems
  Title: EngagementLevelFactItems

  The facts about the engagement level of a record generated using the object and record level metrics.

{
    "type":"array",
    "description":"The engagement level fact items.",
    "items":{
        "$ref":"#/components/schemas/EngagementLevelFactItems"
    }
}

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

Type: object

Title: EngagementLevelFactItems

The facts about the engagement level of a record generated using the object and record level metrics.

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.
• ExplanationText: string
  The explanation for the record classification .
• InsightFactId: integer
  The auto-generated unique identifier for an insight fact.
• 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.
• ObjectId: integer
  The PK attribute value of the CRM record
• ObjectType: string
  The object type name of the CRM entity.
• RecordClassification: string
  The classification text of the record based on the facts generated.
• RecordClassificationCode: string
  The classification code of the record based on the facts generated.
• RecordFacts: array RecordFacts
  The record level facts generated by comparing record query result against object metrics.

{
    "title":"EngagementLevelFactItems",
    "type":"object",
    "properties":{
        "InsightFactId":{
            "type":"integer",
            "description":"The auto-generated unique identifier for an insight fact."
        },
        "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"
        },
        "RecordClassificationCode":{
            "type":"string",
            "description":"The classification code of the record based on the facts generated."
        },
        "RecordClassification":{
            "type":"string",
            "description":"The classification text of the record based on the facts generated."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time"
        },
        "ExplanationText":{
            "type":"string",
            "description":"The explanation for the record classification ."
        },
        "CreatedBy":{
            "type":"string",
            "description":"Indicates the user who created the row."
        },
        "RecordFacts":{
            "type":"array",
            "description":"The record level facts generated by comparing record query result against object metrics.",
            "items":{
                "$ref":"#/components/schemas/EngagementLevelFact"
            }
        },
        "ObjectId":{
            "type":"integer",
            "description":"The PK attribute value of the CRM record"
        },
        "ObjectType":{
            "type":"string",
            "description":"The object type name of the CRM entity."
        }
    },
    "description":"The facts about the engagement level of a record generated using the object and record level metrics."
}

Nested Schema : RecordFacts

Type: array

The record level facts generated by comparing record query result against object metrics.

Show Source

• Array of: object EngagementLevelFact
  Title: EngagementLevelFact

  The fact data about the engagement level.

{
    "type":"array",
    "description":"The record level facts generated by comparing record query result against object metrics.",
    "items":{
        "$ref":"#/components/schemas/EngagementLevelFact"
    }
}

Nested Schema : EngagementLevelFact

Type: object

Title: EngagementLevelFact

The fact data about the engagement level.

Show Source

• AccountName: string
  The account name.
• DaysSinceLastTouched: string
  The days since last touched the record.
• InsightSubTypeCode: string
  A unique code which is a sub type of the current insight type.
• LastTouchedDateTime: string (date-time)
  Indicates when the account or a record related to the account was last updated.
• LastTouchedObjectId: string
  The last touched object ID.
• LastTouchedObjectType: string
  The last touched object type.
• LastTouchedRecordName: string
  The last touched record name.
• LastTouchedRecordType: string
  The last touched record type.
• LastTouchedSourceObjectType: string
  The last touched source object type.
• LastTouchedSourceRecordName: string
  The last touched source record name.
• SalesCycle: string
  The sales cycle value.
• TouchedRecordCount: string
  The number of records updated by the user within the stipulated time frame.

{
    "title":"EngagementLevelFact",
    "type":"object",
    "properties":{
        "AccountName":{
            "type":"string",
            "description":"The account name."
        },
        "DaysSinceLastTouched":{
            "type":"string",
            "description":"The days since last touched the record."
        },
        "LastTouchedSourceObjectType":{
            "type":"string",
            "description":"The last touched source object type."
        },
        "LastTouchedObjectId":{
            "type":"string",
            "description":"The last touched object ID."
        },
        "SalesCycle":{
            "type":"string",
            "description":"The sales cycle value."
        },
        "InsightSubTypeCode":{
            "type":"string",
            "description":"A unique code which is a sub type of the current insight type."
        },
        "TouchedRecordCount":{
            "type":"string",
            "description":"The number of records updated by the user within the stipulated time frame."
        },
        "LastTouchedDateTime":{
            "type":"string",
            "description":"Indicates when the account or a record related to the account was last updated.",
            "format":"date-time"
        },
        "LastTouchedObjectType":{
            "type":"string",
            "description":"The last touched object type."
        },
        "LastTouchedSourceRecordName":{
            "type":"string",
            "description":"The last touched source record name."
        },
        "LastTouchedRecordName":{
            "type":"string",
            "description":"The last touched record name."
        },
        "LastTouchedRecordType":{
            "type":"string",
            "description":"The last touched record type."
        }
    },
    "description":"The fact data about the engagement level."
}

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