Versions Compared

Old Version 5

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...


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 product products of classification SERVICE and SERVICES with service type TERMED or USAGE, or for products of classification PHYSICALGOODPHYSICALGOODS

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

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
titleExample 1

HTTP Method: POST GET


Request


Response

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "data": {
        "performance_calculation_period": "November 2017 - October 2018",
        "product_total_revenue": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}



Expand
titleExample 2

HTTP Method: POST


Request

Body

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
	"token":"{{token}}",
	"product_identifier": {
		"alternative_code": "TM"
	}
}

Response

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
    "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
titleExample 3

HTTP Method: POST


ResponseRequest

Body

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
	"token":"{{token}}",
	"product_identifier": {
		"code": "Serendipity"
	}
}

Response

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
    "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": ""
    }
}