Reports

Sources - UTM

Returns grouped UTM performance for orders in the selected period. Responses are capped
at 1500 grouped rows.

GET /api/v1/store/reports/sources-utms

Sources - UTM

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/reports/sources-utms' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "meta": {
    "report_link": "https://app.metorik.com/reports/sources/utms"
  },
  "data": [
    {
      "utm_source": "google",
      "utm_campaign": "spring-sale",
      "count": 29,
      "total": 4310,
      "total_refunds": 50,
      "total_taxes": 357.44,
      "total_shipping": 188,
      "total_fees": 24.1,
      "average": 148.62,
      "net": 4038.46,
      "average_net": 139.26,
      "source_combined": "google-spring-sale"
    }
  ]
}

No response description.

Authorizations

  • Authorization string required header

    Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.

Query Parameters

  • end_date string required

    End date in the store timezone using YYYY-MM-DD format. Example: 2026-02-28

  • order_filters string

    Optional JSON-encoded array of order-level filters applied before calculating the report. See Order Filters Reference. Cannot be combined with segment. Example: [{"field":"billing_address_country","operator":"eq","value":"US"}]

  • segment integer

    Optional saved store-wide order segment ID. You can find the ID on the order segments page. Example: 123

  • source_type string required

    Comma-separated UTM fields to group by. Allowed: utm_campaign, utm_medium, utm_source, utm_term, utm_content, utm_id. Example: utm_source,utm_campaign

  • start_date string required

    Start date in the store timezone using YYYY-MM-DD format. Example: 2026-02-01

Headers

  • Accept string required

    Response format header. Example: application/json

Response

application/json
  • meta object
    + Show Child Attributes
    • report_link string
  • data[] object array
    + Show Child Attributes
    • utm_source string
    • utm_campaign string
    • count integer
    • total integer
    • total_refunds integer
    • total_taxes number
    • total_shipping integer
    • total_fees number
    • average number
    • net number
    • average_net number
    • source_combined string