Read marketing spend and Quote value series

When to use this endpoint

Compare selected marketing-source expense with selected Quote status net values across report periods. Use this for the matching saved Reports dashboard chart or table; the result is chart series, not raw object records or a PDF.

res contains status-value series first, then source-expense series, retaining request order within each group. xLabels is the period axis; xLabels1 is empty.

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

Example request

$report = FM_api('Report_getMarketingExpense', [
	'daysFrom'=>'1768003200',
	'daysTo'=>'1768003200',
	'durationType'=>'1',
	'frequency'=>'0',
	'legend'=>['1~Status','7~Lead Source'],
]);

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 contains status-value series first, then source-expense series, retaining request order within each group. xLabels is the period axis; xLabels1 is empty.

Errors and unusual responses

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.
• legend entries are ID~Status or ID~Lead Source, with exact case and spacing. Quote-status selections read total_net by cdate; source selections read expense from marketing_expenses by expense_date.
• When source legends are present, they also restrict the Quote status totals to those marketing_source IDs. Expense totals are not restricted by Quote status.
• The handler forces the axis userType to 0. User/customer/asset selection and displayType cannot turn it into a per-user report or a count report.
• Interleaved input legends are regrouped: all statuses precede all lead sources in res. Unknown suffixes add no series; duplicates can initialize repeated rows while only the first match is populated.
• Both Quote value and marketing expense aggregates are integer-converted. Empty legend is not rejected and returns no series, while malformed ID~group strings return an invalid-parameter error before SQL.
• 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.
• The axis is forced to the summary period sequence, so xLabels contains dates and xLabels1 is empty. Zero buckets are prefilled; unmatched 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 Marketing Budget report, set its filters, and inspect Network for Report_getMarketingExpense. 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=MarketingExpense, change or preview its filters, and inspect Report_getMarketingExpense. 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_getMarketingLeadSource — Break down Quote count or value by marketing source, report period and selected entity.
• Report_getSalesPerLeadSource — Compare selected marketing-source Quote activity across status, period and selected entity axes.