Skip to main content

Engagement-Level APIs

Backstory Engagement Levels are calculated scores based on the volume, types, and recency of activities matched against the related Account, Opportunity, Contact, or Lead.

Read more in the Help Center: Engagement Levels

We are introducing access to engagement levels for all business objects in our APIs, including historical trends with snapshots for the last three months for Accounts, Contacts, and Leads. For Opportunities, we examine snapshots calculated from the Opportunity creation date to the current date or the Opportunity close date.

Engagement-level APIs will enable you to integrate scores into your BI tool or data platform of choice.
​

How to make a request

Path

Path params

id

Optional - Account/Opportunity/Contact/Lead ID

Path params

engagement_type

Accounts/Opportunities/Contacts/Leads

Method

GET

Pagination

Yes

Schema

Field

Type

Description

oopportunity-crm-id, account-crm-id,contact-crm-id,lead-crm-id

String

CRM ID of object - Account/Opportunity/Contact/Lead

score

Integer

Engagement level calculated for an object at a specific time

timestamp

Integer

The time when the engagement level was calculated

Did this answer your question?