Engagement Response Rate

Returns percentage of engagements for different sources (Facebook, Twitter, etc), for the given node(s).

Endpoint:

GEThttps://api1.consumerism.pressganey.com/api/service/v1/engagements/statistics

Request Parameters

Property	Type	Description	Required/Optional
accessToken	String	Access token received from the platform .Unique identifier of a node for which data is requested.	Required
node	String	Unique identifier of a node for which data is requested.Multiple node parameter can be used in a single GET.	Required
fromDate	String	ISO-8601 date format. Eg: 2014-01-01T00:00:00Z. If not provided, this will be considered as todate - 1 year	Optional
toDate	String	ISO-8601 date format. Eg: 2014-01-01T00:00:00Z	Optional
source	String	Without a source parameter. Multiple sources can be provided as source=Facebook&source=Twitter etc OR for calculating response rate.source=Facebook,Twitter etc	Optional, default all sources will be used.

Example: 2014-01-01T00:00:00Z The date up to which the response rate shall be calculated. Example: 2015-01-01T00:00:00Z

The source for which response rate should be calculated. The sources are named by its name like Facebook, Twitter, etc. You can get a complete list of supported sources by calling the API year back from current date.

|

Response

A JSON object containing overall response rate and individual response rate per source for each node.

{
    "filter": {
        "configVersion": "v1",
        "period": {
            "from": "2023-08-01T00:00:00Z",
            "to": "2024-08-01T19:33:36Z"
        },
        "sources": [
            {
                "name": "Google"
            },
            {
                "name": "RateMDs"
            },
            {
                "name": "Sharecare"
            },
            {
                "name": "WebMD"
            },
            {
                "name": "Wellness"
            },
            {
                "name": "Yellow Pages"
            },
            {
                "name": "Yelp"
            }
        ]
    },
    "nodes": [
        {
            "engagements": [
                {
                    "draftCount": 0,
                    "engagedReviewCount": 0,
                    "responseRate": 0,
                    "source": "Yellow Pages",
                    "totalEngagements": 0,
                    "totalReviewCount": 1
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 0,
                    "responseRate": 0,
                    "source": "Yelp",
                    "totalEngagements": 0,
                    "totalReviewCount": 113
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 11319,
                    "responseRate": 53.48,
                    "source": "Google",
                    "totalEngagements": 11322,
                    "totalReviewCount": 21164
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 0,
                    "responseRate": 0,
                    "source": "Vitals",
                    "totalEngagements": 0,
                    "totalReviewCount": 26
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 0,
                    "responseRate": 0,
                    "source": "RateMDs",
                    "totalEngagements": 0,
                    "totalReviewCount": 9
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 0,
                    "responseRate": 0,
                    "source": "WebMD",
                    "totalEngagements": 0,
                    "totalReviewCount": 73
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 1,
                    "responseRate": 0.42,
                    "source": "Healthgrades",
                    "totalEngagements": 1,
                    "totalReviewCount": 237
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 12,
                    "responseRate": 50,
                    "source": "Better Business Bureau",
                    "totalEngagements": 12,
                    "totalReviewCount": 24
                },
                {
                    "draftCount": 0,
                    "engagedReviewCount": 0,
                    "responseRate": 0,
                    "source": "Sharecare",
                    "totalEngagements": 0,
                    "totalReviewCount": 5
                }
            ],
            "name": "Venacava Healthcare",
            "node": "11382",
            "overallResponseRate": 37.11
        }
    ],
    "releaseDate": "2015-01-13",
    "version": "v1.0"
}

Response Parameters

Property	Type	Description
filter	Object	The filters applied on the testimonials.
filter.sources	Array	The sources used for calculating response rate. If no sources are provided you will get a complete list of sources.
nodes	Array	The nodes for which data is being returned.
nodes.node	String	Unique identifier of the node.
nodes.name	String	The name of the node.
nodes.overallResponseRate	Decimal	The overall response rate accross the requested sources .
engagements	Array	A JSON array containing response rate per source.
engagements.source	String	The source for which response rate is calculated.
engagements.responseRate	Decimal	The response rate for this source
engagements.totalReviewCount	Integer	The total reviews for this source
engagements.engagedReviewCount	Integer	The number of reviews which are engaged for this source