Page Comparison

...

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0

Excerpt
This method returns information related with the performance of a product. Single product The performance of a single product is returned by each call. It is only applicable for products of classification SERVICES with service type TERMED or USAGE, or for products of classification PHYSICALGOODS

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

product_identifier

(mandatory)

Identifier

The identifier of the product that should be used for calculating its performance. The allowed product identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

Applicable only for products of

classification SERVICE and type TERMED or USAGE, or

classification PHYSICALGOOD

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:product_performance
	V4:product_performance

Examples

Expand

title	Example 1

HTTP Method: POST GET

Request

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
    "data": {
        "performance_calculation_period": "November 2017 - October 2018",
        "product_total_revenue": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 2

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
	"token":"{{token}}",
	"product_identifier": {
		"alternative_code": "TM"
	}
}

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
    "data": {
        "performance_calculation_period": "September 2016 - August 2017",
        "number_of_subscriptions_with_active_service": 33,
        "product_total_revenue": 204.74
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 3

HTTP Method: POST

Request

ResponseBody

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
	"token":"{{token}}",
	"product_identifier": {
		"code": "Serendipity"
	}
}

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
    "data": {
        "performance_calculation_period": "September 2016 - August 2017",
        "total_number_of_adding_service_on_subscriptions": 1893,
        "product_total_revenue": 10900.48
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions

Response Data

Examples