Last updated

Segment Analytics

Integrate Segment Analytics into Redocly project.

Configuration

OptionTypeDescription
writeKeystringREQUIRED. Amplitude write key
includeInDevelopmentbooleanSet this option to true to enable Segment Analytics in development mode and preview builds. Default is false.
trackPagebooleanSet this to false to disable page visits tracking. Defaults to true.
includeTitleInPageCallbooleanSet this to false to exclude page title from page view event. Defaults to true
hoststringSet this if you need to proxy events through a custom endpoint

Example

analytics:
  segment:
    includeInDevelopment: true
    writeKey: my-write-key
    trackPage: true
    includeTitleInPageCall: true
    host: https://my-custom-host.com
 
Next page