File Download

Event Serialization

always

Business Use Case

["1️⃣ Customer Service: invoice PDF downloads rise after an order-page change → check that invoice-request tickets fall.","2️⃣ Order History PM: mobile-web invoice downloads trail desktop by device_category → move the button above the fold.","3️⃣ Merchandising: size-guide or manual PDFs rank high by file_name → link the top guides from product pages."]

Business Criticality

Medium

Journey / Navigation Area

Engagement

Owning Function

Customer Service

Calculation Notes

["1️⃣ Fires on click of a link ending in a tracked extension (pdf, csv, xlsx, docx, txt, zip, mp4…); records click intent, not a completed download.","2️⃣ Serialization always: every click is a hit. Dedupe on link_url within a session when counting unique documents downloaded.","3️⃣ Required: file_name, file_extension, link_url. Optional: link_text, link_id, link_classes. Enhanced measurement fills all six from the link.","4️⃣ Exclude tokenised invoice links from enhanced measurement; push file_download from the click handler with link_url minus query and tokens.","5️⃣ Honour Consent Mode: with analytics_storage denied only cookieless pings are sent; no user or order identifiers are added to the event.","6️⃣ Invoices served from blob URLs or extensionless endpoints are missed; push file_download from the click handler with the same parameters.","7️⃣ Do not add a GTM-pushed file_download while enhanced measurement is on for the same links; each click would count twice."]

Data Mappings

{
  "event": [
    {
      "eventInfo": {
        "eventName": "file_download",
        "eventAction": "File Download",
        "type": "file_download"
      },
      "attributes": {
        "file_name": "/invoices/invoice.pdf",
        "file_extension": "pdf",
        "link_url": "https://www.example.com/invoices/invoice.pdf",
        "link_text": "Download invoice",
        "link_id": "invoice-download-link",
        "link_classes": "btn btn-download"
      }
    }
  ]
}

{
  "event": "file_download",
  "file_name": "/invoices/invoice.pdf",
  "file_extension": "pdf",
  "link_url": "https://www.example.com/invoices/invoice.pdf",
  "link_text": "Download invoice",
  "link_id": "invoice-download-link",
  "link_classes": "btn btn-download"
}

{
  "event": "file_download",
  "file_download": {
    "file_name": "/invoices/invoice.pdf",
    "file_extension": "pdf",
    "link_url": "https://www.example.com/invoices/invoice.pdf",
    "link_text": "Download invoice",
    "link_id": "invoice-download-link",
    "link_classes": "btn btn-download"
  }
}

{
  "eventType": "web.webinteraction.linkClicks",
  "web": {
    "webInteraction": {
      "name": "file_download",
      "type": "download",
      "linkClicks": {
        "value": 1
      }
    }
  },
  "_tenant": {
    "engagement": {
      "fileDownload": {
        "fileName": "/invoices/invoice.pdf",
        "fileExtension": "pdf",
        "linkUrl": "https://www.example.com/invoices/invoice.pdf",
        "linkText": "Download invoice",
        "linkId": "invoice-download-link",
        "linkClasses": "btn btn-download"
      }
    }
  }
}

Source Data

Dependencies

Prerequisite: List the dependencies required for this Event

Report Attributes

Segment Eligibility

Governance

Dimensions

Derived Entities

GitHub

Community Discussion