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

class mousepy.api.heatmaps.Heatmaps(parent, uri: str = '', **kwargs)

Bases: mousepy.api.API

details(uri) → mousepy.api.heatmaps.Heatmaps

list(detailed=False) → typing.Dict

Lists all available pages along with their specs :return:

page_list() → typing.List

mousepy.api.website module

class mousepy.api.website.Website(parent, site_name: str, **kwargs)

Bases: mousepy.api.API

ALIGNMENT_CENTER = 'Center'

ALIGNMENT_FLEXIBLE = 'Flexible'

ALIGNMENT_LEFT = 'Left'

ALIGNMENT_RIGHT = 'Right'

STATUS_NOT_INSTALLED = 'NotInstalled'

STATUS_PAUSED = 'Paused'

STATUS_RECORDING = 'Recording'

STATUS_STOPPED = 'Stopped'

alignment

anonymize_ips

created

domains

encoding

excluded_ips

heatmaps(uri=None) → mousepy.api.heatmaps.Heatmaps

Parameters:uri – Uri of the page to load the heatmaps from. Returns:Heatmaps

id

merge_urls

name

page_identifiers

read_only

recording_rate

recordings(recording_id: str = None, search: str = None, from_date=None, to_date=None, country: str = None, tags: list = None, vars: dict = None, star: bool = None, limit: int = None, meta: bool = False, **kwargs) → typing.Union[mousepy.api.recordings.Recordings, mousepy.api.recordings.recording.Recording]

Returns Recording if an id is provided otherwise returns Recordings

Parameters:

• recording_id – Recording ID filter
• search – Text search filter
• from_date – Start date filter
• to_date – End date filter
• country – country filter
• tags – tag filter
• vars – variable filter
• star – star filter
• limit – Maximum amount of values returned
• meta – Alias for limit = 0
• kwargs – Other potential filters as documented in https://api-docs.mouseflow.com/#filters

Returns:

Recordings or Recording

status

width

mousepy.api.websites module

class mousepy.api.websites.Websites(parent, **kwargs)

Bases: mousepy.api.API

list(id_as_key=False, list_of_objects=False) → dict

website(site)

Parameters:site – The name of the site to target Returns:Website

Module contents

class mousepy.api.API

Bases: object

Base API request handling class

POST_METHOD_DATA = 'data'

POST_METHOD_PARAMETERS = 'params'

auth = ''

debug = False

delete(*args, **kwargs)

Makes a delete request

Parameters:

• args –
• kwargs –

Returns:

get(*args, **kwargs)

Makes a get request

Parameters:

• args –
• kwargs –

Returns:

list() → dict

post(*args, data: list = None, method: str = 'params', **kwargs)

Makes a post request using either json or data methodology

Parameters:

• args –
• data –
• method –
• kwargs –

Returns:

put(*args, **kwargs)

Makes a put request

Parameters:

• args –
• kwargs –

Returns:

refresh()

Forcefully trigger the get request :return:

response

send(**kwargs)

url = ''

value

exception mousepy.api.CannotCreateEmptyVariablesException(*args, **kwargs)

Bases: BaseException

exception mousepy.api.IllegalStringLengthException(*args, **kwargs)

Bases: BaseException

exception mousepy.api.PageNotFoundException(*args, **kwargs)

Bases: Exception