Segment

Integrate Segment with your Mintlify documentation to route analytics events to downstream tools like warehouses, CRMs, and marketing platforms.

Add your Segment write key to your docs.json file to send analytics to Segment.

Analytics

"integrations": {
    "segment": {
        "key": "required",
        "cdnUrl": "optional"
    }
}

Example

"integrations": {
    "segment": {
        "key": "nqJxiRG15Y6M594P8Sb8ESEciU3VC2",
        "cdnUrl": "https://cdn.example.com"
    }
}

Configuration options

key (string, required) — Your Segment write key.
cdnUrl (string) — A custom CDN URL for loading the Segment script. Use this if you configure a custom domain in Segment to serve analytics from your own subdomain, which helps avoid ad blockers that block cdn.segment.com. Must be an HTTPS URL without query parameters or fragments. Defaults to https://cdn.segment.com.