api package¶
api module¶
-
mindreader.api.api.get_snapshot_by_id(user_id, snapshot_id)¶ Get snapshot by its id.
-
mindreader.api.api.get_snapshot_topic(user_id, snapshot_id, topic)¶ Get a snapshot specific topic.
-
mindreader.api.api.get_snapshot_topic_data(user_id, snapshot_id, topic)¶ If the snapshot topic contained only metadata, this will return the actual data.
-
mindreader.api.api.get_snapshots_by_user_id(user_id)¶ Get list of snapshots that belongs to user with user_id.
-
mindreader.api.api.get_user_by_id(user_id)¶ Get user by his id.
-
mindreader.api.api.get_users()¶ Get all available users.
-
mindreader.api.api.run_api_server(host, port, database_url)¶ Runs the api server and serves data. Entry names are returned in javascript convention (variableName).
- Parameters
host – api host.
port – api port.
database_url – database to serve data from.