Read opportunity value growth

When to use this endpoint

Return integer opportunity value and sequential growth across configured report periods and entities. Use this for the matching saved Reports dashboard chart or table; the result is chart series, not raw object records or a PDF.

res[0] is rounded growth percentage and res[1] is integer summed opportunity value; xLabels/xLabels1 use the shared period/entity axis.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. The handler requires login and account feature bit 8192 in employer.features.

The dispatcher rejects these legacy Report routes for a user with configured TeamAccess record scope, including assigned-only/parent-manager access or a department hierarchy scope. It returns an explicit legacy-report scope error; it does not return a silently partial chart.

For an allowed unscoped request, the handler reads the authenticated tenant and adds no Reports/Quotes/Invoices page-permission check, account-manager restriction or per-object ownership check. Selecting user IDs is a chart filter, not authorization.

Parameters

Parameter	Type	Required	Description
`daysFrom`	Integer string	Yes	Start of range: relative day offset when durationType is omitted/not 1; Unix seconds when durationType=1. Must be an integer string or integer; blank and malformed values are rejected. Use an ordered, bounded range.
`daysTo`	Integer string	Yes	End of range in the same mode as daysFrom. Must be an integer; no reversed-range validation. The handler expands to the final day’s 23:59:59 unless the behavior below says otherwise.
`durationType`	Integer string	No	Defaults to 0. Exactly 1 uses Unix seconds; every other integer treats daysFrom/daysTo as offsets from the current PHP time. ISO date strings are not parsed as dates.
`userType`	Integer string	Yes	0 summary, 1 users, 2 customers, 3 asset-axis labels. Must be an integer from 0 through 3. User grouping uses user_id. Type 3 still aggregates customer_id rather than following an asset relationship.
`user`	Native array of ID strings or ["All"]	No	Defaults to ["All"]; a supplied empty list is rejected. Summary mode ignores the selection. IDs are validated as integer values before SQL. Do not JSON-encode the array.
`frequency`	Integer string	No	Defaults to 0 monthly; 1 weekly, 2 quarterly, 3 yearly. Controls both helper labels and SQL period grouping. Values outside 0–3 are rejected.

Example request

$report = FM_api('Report_getOpportunitySalesGrowth', [
	'daysFrom'=>'1768003200',
	'daysTo'=>'1768003200',
	'durationType'=>'1',
	'frequency'=>'0',
	'userType'=>'0',
	'user'=>['All'],
]);

Example response

{
  "res": [
    [
      0
    ],
    [
      0
    ]
  ],
  "xLabels": [
    "Jan 2026"
  ],
  "xLabels1": []
}

The example uses Unix seconds for 2026-01-10 00:00:00 UTC. The handler expands the resulting account-local date to its documented day boundaries.

Representative empty-cohort result from the real handler with a January 2026 summary axis.

res[0] is rounded growth percentage and res[1] is integer summed opportunity value; xLabels/xLabels1 use the shared period/entity axis.

Errors and unusual responses

Response	Condition
`{"error":"not logged in"}`	No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
`{"error":"This legacy report does not support your configured record scope. Use the scoped Contracts reports or table exports."}`	The dispatcher detects configured TeamAccess record scope. This applies before the handler’s own checks.
`{"error":"no permission to access api"}`	Account reporting feature bit 8192 is absent.
`{"error":"missing parameter: daysFrom"}`	daysFrom omitted or null. Present blank scalars and malformed list controls return an invalid-parameter error instead. Required lists must be native arrays.
`{"error":"missing parameter: daysTo"}`	daysTo omitted or null. Present blank scalars and malformed list controls return an invalid-parameter error instead. Required lists must be native arrays.
`{"error":"missing parameter: userType"}`	userType omitted or null. Present blank scalars and malformed list controls return an invalid-parameter error instead. Required lists must be native arrays.
`{"error":"invalid parameter: daysFrom"}`	A supplied numeric control is malformed, a list has the wrong shape or an unsupported token, or frequency/userType is outside 0–3. The message names the invalid control; validation occurs before chart SQL.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

List controls must be native lists of strings or integers. Encoded JSON strings, nested/object-keyed arrays and nonnumeric IDs are rejected before SQL. Only the documented All, Opportunity and composite legend tokens are accepted. Empty user/status/leadSource lists are invalid; empty legends are accepted only on the status-series reports, MarketingExpense and SalesPerLeadSource.
Filters opportunity cdate as Unix seconds using SQL UNIX_TIMESTAMP boundaries. It includes all opportunity statuses and sums value; there is no won-only or converted-only condition.
Groups user_id for userType=1 and customer_id for types 2 or 3. The asset-axis mode does not follow an asset relationship.
Growth tracks the previous cell separately for each entity. Users/customers in the same period are never compared with one another. The first requested period for each entity has growth zero.
For a positive prior-period value, growth is round((current-previous)/previous*100). With a zero or negative previous value, growth is zero because no positive comparison baseline exists. Missing cells remain zero and can produce -100 after positive sales.
The handler switches to the account PHP timezone before generating both axis dates and SQL boundaries. SQL Unix conversion still follows the database session timezone; deployment timezone alignment remains relevant.
There is no pagination, row limit or result checkpoint. Keep the date range and entity selection bounded; label helpers expand every selected period/entity combination.
The underlying aggregate queries do not exclude deleted source objects. Related label/source queries also have no general active/deleted filter. Totals can differ from active-record lists; no deletion behavior is changed by this documentation.
PHP date conversion uses the account timezone setting (missing/null falls back to Europe/Dublin; blank means UTC). SQL date/Unix functions use the database session timezone; alignment is not enforced by this handler. Date endpoints are expanded to whole local days, not retained at the supplied time of day.
Amounts are aggregate reporting numbers without currency codes or decimal preservation. Do not treat them as an invoice/quote ledger export.
Axis order is period then entity name. One selected entity collapses the entity labels into date labels; multiple entities repeat names in xLabels with dates in xLabels1. Temporary users whose meta.is_tmp is non-null are excluded from the user-axis lookup. Zero buckets are prefilled; unmatched entity/date keys are dropped. Weekly labels and SQL grouping use ISO week-year and enumerate actual Mondays, including ISO week 53 and calendar-year boundary weeks.
No direct mobile-app or m-service caller was found for this route. Browser report definitions are separate from the newer Report_getData template contract.

Side effects

Reads report data only. No record, audit, status, notification, mail, report-cache or schema writes occur. Date helpers temporarily change PHP timezone on paths noted above.

See it in Fieldmotion

CRM1

Open Reports dashboard, add or preview the Sales Opportunity Growth report, set its filters, and inspect Network for Report_getOpportunitySalesGrowth. pageReportDashboard.js builds Report_get plus the saved api name and expands All selectors using reportDashboard/Constant.js; chart presentation options and labels are client-side.

CRM2

Open the saved Reports dashboard report using api=OpportunitySalesGrowth, change or preview its filters, and inspect Report_getOpportunitySalesGrowth. lib/displayReport.js builds this route dynamically from the saved definition, expands supported All selectors, and renders the returned series. The newer widgetReport.js instead calls Report_getData with a report template; its payload is a different contract.

Related endpoints

Report_getOpportunityQuoteWonFunnel — Compare unquoted opportunities, non-won Quotes and won/paid Quotes created during one reporting range.
Report_getQuotesStatusUser — Compare selected Quote statuses and an optional overall series across report periods and selected owners or customers.
Report_getInvoicesStatusUser — Compare selected Invoice statuses and an optional overall series across report periods and selected owners or customers.