amplitude.browser.yml

settings:
  platform: Browser
  language: TypeScript
  sdk: "@amplitude/amplitude-browser"
  output: ./amplitude
  outputFileName: browser
  typedAnchorName: typed
environments:
  development:
    experiment:
      apiKey: my-deployment-key
    analytics:
      apiKey: my-api-key
  production:
    experiment:
      apiKey: my-deployment-key
    analytics:
      apiKey: my-api-key
user:
  description: Collection of user properties
  required:
    - referralSource
  properties:
    referralSource:
      description: How the user was brought to the app
      enum:
        - facebook
        - twitter
        - other
    favoriteSongCount:
      description: Total number of favorited songs
      type: integer
analytics:
  events:
    Add To Cart:
      description: An item was added to the cart
    Checkout:
      description: The user completed their purchase
    Event With Array:
      description: An Event with Array props
      properties:
        arrayProp:
          type: array
          items:
            type: string
    Event With Const:
      description: An Event with only Const props
      properties:
        constProp:
          description: Constant value shouldn't be settable
          const: true
      required:
        - constProp
    Song Favorited:
      description: A song was added to a user's favorites
      properties:
        aConstant:
          description: Constant values shouldn't be settable
          const: true
        songId:
          description: The song unique identifier
          type: string
        optionalProp:
          description: An optional value
          type: string
      required:
        - aConstant
        - songId
    Song Played:
      description: A song was played
      properties:
        songId:
          description: The song unique identifier
          type: string
        songFavorited:
          description: If the song is a favorite
          type: boolean
      required:
        - songId
    User Logged In:
      description: The user logged in
      properties:
        method:
          enum:
            - email
            - facebook
            - google
      required:
        - method
    User Signed Up:
      description: A user signed up
      properties:
        referralSource:
          description: How the user was brought to the app
          enum:
            - facebook
            - twitter
            - other
experiment:
  flags:
    Flag Codegen Enabled:
      variants:
        ? on
    A Multi Variate Experiment:
      payload:
        description: An array of strings
        type: array
        items:
          type: string
      variants:
        ? generic
        ? ampli