Available from CRM.COM R14.0.0
This method returns information related with the performance of a 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:
| ||||||||||||
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
Name | Type | Description |
|---|---|---|
performance_calculation_period | String | The period that the performance is calculated for, which is the previous 12 Months |
product_total_revenue | Number | The total revenue of the service calculated as the total amount billed excluding Taxed amounts (VAT and other Taxes) |
number_of_subscriptions_with_active_service | Number | The total number of all the subscriptions that include this service. The service on the subscription must be Effective and its first activation date is within the last 12 months (including current month) Applicable only for products of classification SERVICE with type TERMED |
| total_number_of_adding_service_on_subscriptions | Number | The total number of times the service was added on subscriptions Applicable only for products of classification SERVICE with type USAGE |
Examples
HTTP Method: POST
Request
Body
{
"token":"{{token}}",
"product_identifier": {
"id": "D613415339C14975B28BB4FC11598E93"
}
}
Response
{
"data": {
"performance_calculation_period": "September 2016 - August 2017",
"product_total_revenue": 191
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: POST
Request
Body
{
"token":"{{token}}",
"product_identifier": {
"alternative_code": "TM"
}
}
Response
{
"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": ""
}
}
HTTP Method: POST
Request
Body
{
"token":"{{token}}",
"product_identifier": {
"code": "Serendipity"
}
}
Response
{
"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": ""
}
}