Actions25
- Store Actions
- Product Actions
- Category Actions
- Variation Actions
- Brand Actions
- Coupon Actions
- Report Actions
- Engage Profile Actions
- Engage Unsubscribe Actions
- Search Actions
Report → Customer Sources — UTM
AI-generatedSummary
Retrieve a report of customer acquisitions grouped by a selected UTM dimension within a specified date range from the Metorik analytics API.
Inputs
- Start Date (required) — Start date in YYYY-MM-DD format (store timezone) to define the beginning of the reporting period.
- End Date (required) — End date in YYYY-MM-DD format (store timezone) to define the end of the reporting period.
- Source Type (required) — The UTM dimension to group customer acquisition data by. Options include utm_source, utm_medium, utm_campaign, utm_term, and utm_content.
Output shape
a JSON object representing the customer acquisition report grouped by the selected UTM dimension over the specified date range
The data is fetched from the '/reports/customer-sources-utm' endpoint using the specified start and end dates, along with the chosen sourceType as query parameters. The response contains detailed reporting data about customer acquisition sources based on UTM parameters.
Examples
Example 1: Get customer acquisitions grouped by UTM medium between 2026-04-01 and 2026-04-04
Set Start Date to '2026-04-01', End Date to '2026-04-04', and Source Type to 'utm_medium'. Invoke this operation to receive the grouped customer UTM source data for that period.