Category Benchmark

The call returns the scores for the different operational categories, along with the number of positive, neutral and negative insights for the specific location/person ID combination.

Endpoint:

GEThttps://api1.consumerism.pressganey.com/api/service/v1/sentiment/categoryBenchmark

Request Parameters

Property	Type	Description	Required/Optional
accessToken	String	Access token received from the platform	Required
fromDate	String	The start date in the ISO 8601 format.	Required
toDate	String	The end date in the ISO 8601 format.	Required
locationId	String	Unique code identifier of a location in the platform.	Either a locationId or a providerId is required.
providerId	String	Unique code identifier of a person. Can be NPI or a proprietary identifier defined by the platform.	Either a locationId or a providerId is required

Response

A JSON object which contains the scores for the different operational categories, along with the number of positive, neutral and negative insights for the specific location/person ID combination. This interface will allow the user to retrieve for a specific location, a specific physician, or for a physician within a specific location.

Sample Response JSON

{
    "avatar": {
        "location": {
            "code": "",
            "name": ""
        },
        "name": "Venacava Health System",
        "nodeId": 123456,
        "parentNodeId": 0,
        "person": {
            "code": "",
            "name": ""
        },
        "type": "Brand"
    },
    "data": [
        {
            "bottomCategory": true,
            "color": "#ff0000",
            "id": "50053",
            "insights": "6",
            "name": "Medicine and Side Effect",
            "negative": "6",
            "neutral": "0",
            "parent_category": "50007",
            "percentNegative": "100.00",
            "percentNeutral": "0.00",
            "percentPositive": "0.00",
            "positive": "0",
            "reviewCount": 5,
            "score": "0.0",
            "tagColor": "0Xff0000",
            "topCategory": false
        },
        {
            "bottomCategory": true,
            "color": "#ff0000",
            "id": "50064",
            "insights": "47",
            "name": "Cost of Care",
            "negative": "47",
            "neutral": "0",
            "parent_category": "50008",
            "percentNegative": "100.00",
            "percentNeutral": "0.00",
            "percentPositive": "0.00",
            "positive": "0",
            "reviewCount": 34,
            "score": "0.0",
            "tagColor": "0Xff0000",
            "topCategory": false
        },
        {
            "bottomCategory": true,
            "color": "#ff0000",
            "id": "50069",
            "insights": "2",
            "name": "Payment Options",
            "negative": "2",
            "neutral": "0",
            "parent_category": "50008",
            "percentNegative": "100.00",
            "percentNeutral": "0.00",
            "percentPositive": "0.00",
            "positive": "0",
            "reviewCount": 2,
            "score": "0.0",
            "tagColor": "0Xff0000",
            "topCategory": false
        },
        {
            "bottomCategory": true,
            "color": "#ff0000",
            "id": "50063",
            "insights": "1",
            "name": "Billing Errors",
            "negative": "1",
            "neutral": "0",
            "parent_category": "50008",
            "percentNegative": "100.00",
            "percentNeutral": "0.00",
            "percentPositive": "0.00",
            "positive": "0",
            "reviewCount": 1,
            "score": "0.0",
            "tagColor": "0Xff0000",
            "topCategory": false
        },
        {
            "bottomCategory": false,
            "color": "#ff3700",
            "id": "50070",
            "insights": "4",
            "name": "Price Transparency",
            "negative": "3",
            "neutral": "1",
            "parent_category": "50008",
            "percentNegative": "75.00",
            "percentNeutral": "25.00",
            "percentPositive": "0.00",
            "positive": "0",
            "reviewCount": 3,
            "score": "0.6",
            "tagColor": "0Xff3700",
            "topCategory": false
        }
    ],
    "period": {
        "from": "2023-01-30",
        "to": "2024-01-30"
    },
    "releaseDate": "2015-04-05",
    "version": "v1.4"
}

Response Parameters

Property	Type	Description
filter	Object	The filters applied on the testimonials
percentPositive	Decimal
percentNeutral	Decimal
percentNegative	Decimal
score	Decimal
id	Integer
color
name	String
insights	Decimal
negative	Decimal
positive	Decimal
avatar.name	String
avatar.type	String
person.name	String
person.code	Integer
location.name	String
location.code	Integer