Introduction

Welcome to the Damoov-Admin documentation! This SDK provides a powerful toolset for developers looking to seamlessly integrate and interact with the Damoov platform. By simplifying the process of making API calls, handling responses, and managing data, this SDK helps you get more done with less effort.

Whether you're looking to fetch statistics, scores, trips, waypoints, manage tags or users, the Damoov-Admin SDK has got you covered. Built with a focus on efficiency and ease of use, our SDK ensures you spend less time on boilerplate code and more time on building amazing features for your users.

🚀 Get Started

Jumping into a new SDK can be daunting. That's why we've created a simple guide to get you started with the Damoov-Admin SDK in no time.

1. Installation & Update

Before you can use the SDK, you need to install it. Use pip to easily install the SDK:

pip install damoov-admin

If you want to update the SDK, easily do so using pip.

pip install --upgrade damoov-admin

2. Setting Up Authentication

To ensure the seamless functionality of the Damoov-Admin SDK, authentication of your requests is essential. To achieve this, you'll need to configure the SDK with your email and password. These credentials can be generated by navigating to Datahub, then selecting 'Management', followed by 'Admin Credentials'. For a detailed step-by-step walkthrough, please consult the official guide available at: Damoov Datahub Admin Credentials Guide.

email="[email protected]"
password="YOUR PASSWORD"
variable = <module>.DamoovAuth(email=email, password=password)

Example:

from damoov_admin import statistics

# Your login details
email = "[email protected]"
password = 'YOUR_PASSWORD'

stats = statistics.DamoovAuth(email=email, password=password)

3. Making requests

With authentication out of the way, you can now make requests to the Damoov platform:

variable = <authenticated module>.method(parameters)

Example:

# Fetch daily user statistics
user_d_statistics = stats.user_daily_statistics(
    user_id='USER_ID',
    start_date='2023-09-01T00:00:00',
    end_date='2023-10-02T00:00:00',
    tag=''
)

print('User daily statistics Status:', user_d_statistics)

📦 Modules

Having covered the basics, feel free to delve deeper into our extensive documentation. You'll discover advanced features, handling techniques, and much more, ensuring you harness the full potential of the Damoov-Admin SDK.

📊 Scoring & Statistics

🚗 Trips

👤 Users

🗂️ Accounts

🏆 Engagement