Sales | Metric

This endpoint is to get metrics data for the aplication, like the new customers, sales closing ratio, etc.

Overview

URL	api/{tenantKey}/{orgKey}/sales/metrics
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET Get Sales Closing Ratio
  • GET Get New Customers
  • GET Get Churn Rate

All Resources

This service uses the following resources:

• MetricData

GET Operations

GET Get Sales Closing Ratio

Custom operation 'GetSalesClosingRatio'.

The following elements are required:

companyKey	(string) CompanyKey.
referenceDate	(DateTime?) ReferenceDate.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get New Customers

Custom operation 'GetNewCustomers'.

The following elements are required:

companyKey	(string) CompanyKey.
referenceDate	(DateTime?) ReferenceDate.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Churn Rate

Custom operation 'GetChurnRate'.

The following elements are required:

companyKey	(string) CompanyKey.
referenceDate	(DateTime?) ReferenceDate.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

Resources

MetricData

The following elements are optional:

referenceDate	(DateTime) Reference Date.
value	(decimal) Value.
valueReporting	(decimal) Value Reporting.
homologous	(decimal) Homologous.
homologousReporting	(decimal) Homologous Reporting.
budget	(decimal) Budget.
budgetReporting	(decimal) Budget Reporting.
baseCurrency	(string) Base Currency.
reportingCurrency	(string) Reporting Currency.