mousepy package

Subpackages

• mousepy.api package
  • Subpackages
    • mousepy.api.recordings package
      • Subpackages
        • mousepy.api.recordings.properties package
          • Submodules
          • mousepy.api.recordings.properties.bulktag module
          • mousepy.api.recordings.properties.star module
          • mousepy.api.recordings.properties.tag module
          • mousepy.api.recordings.properties.tags module
          • mousepy.api.recordings.properties.variables module
          • Module contents
      • Submodules
      • mousepy.api.recordings.recording module
      • Module contents
  • Submodules
  • mousepy.api.heatmaps module
  • mousepy.api.website module
  • mousepy.api.websites module
  • Module contents

Module contents

class mousepy.Mouseflow(user, token, location='eu', debug=False, **kwargs)

Bases: mousepy.api.API

Base class for connecting to the mouseflow API

LOCATION_EUROPE = 'eu'

LOCATION_UNITED_STATES = 'us'

websites(site: str = None) → typing.Union[mousepy.api.websites.Websites, mousepy.api.website.Website]

Returns mousepy.api.recordings.Websites unless the site parameter is provided in which case it returns mousepy.api.recordings.Website.

Parameters:site – The name of the site to retrieve Returns:[Website, Websites]