Project Details

View project details

To obtain details about your project:

1. Complete the User authentication and
2. Create a ‘project’ object. The code snippet below shows how to do this using the project hash / id.

The project hash can be found within the URL once a project has been selected:

app.encord.com/projects/view/<project_hash>/summary

app.us.encord.com/projects/view/<project_hash>/summary

Global

# Import dependencies 
from encord import EncordUserClient

# Authenticate using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(ssh_private_key_path="<private_key_path>")

# Get project details using the "<project_hash>" as an identifier
project = user_client.get_project("<project_hash>")

View Collaborator session information

This endpoint is deprecated and retrieves collaborator timers from the Legacy Performance Dashboards, not the Upgraded Analytics Dashboard.

If you want to access the new Analytics Dashboards using the API or SDK contact your Encord team.

Use the list_collaborator_timers() method on a ‘project’ object to obtain session information for each collaborator that has worked on the project within a specified range of dates.

Global

import datetime

from encord import EncordUserClient, Project

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    "<your_private_key>"
)
project: Project = user_client.get_project("<project_hash>")

for timer in project.list_collaborator_timers(
    after=datetime.datetime.now(datetime.timezone.utc)
    - datetime.timedelta(weeks=1)
):
    print(f"Collaborator session: {timer}")