Skip to content

Project Queries

Project queries let you explore individual projects and compare analytics between projects.

Tips

  • Get project IDs first: Use get_organization_summary to discover available projects
  • Note the scene IDs: You'll need scene and version IDs for session queries
  • Check version history: Multiple versions indicate an evolving scene — consider analyzing the most recent version for current behavior
  • Follow-up queries: After viewing project details, try "Show me sessions for scene [name]" to see user engagement data
  • Benchmarking: Use compare_projects to identify best-performing projects and understand what makes them successful

Get project details

Returns detailed information about a specific project, including all scenes within the project, their versions, and associated metadata. Use this tool after identifying project IDs from the organization summary.

Sample queries for project details

  • "Tell me about project 123."
  • "What scenes are in my training application?"
  • "Show me the details for the Demo Project."
  • "List all scenes in project [name]."
  • "What versions exist for my lobby scene?"

Response for project details includes

  • Project name and description
  • List of all scenes with their IDs
  • Scene version history
  • Version-specific metadata (upload dates, polygon counts)
  • Session statistics per scene

Understanding the project details response

The project details response includes scene and version information that you'll need for deeper analysis:

  • Scene ID: Required for session queries
  • Version ID: Identifies a specific iteration of a scene
  • Version Number: Human-readable version identifier

Parameters for project details

Parameter Required Description
project_id Yes The numeric ID of the project (obtained from organization summary)

Compare projects

Compare metrics across multiple projects for benchmarking and performance analysis. This tool is useful for organizations with multiple training programs, applications, or XR experiences that need to be compared side-by-side.

Sample queries for comparing projects

  • "Compare projects 123, 456, and 789."
  • "Which of my training applications has the highest engagement?"
  • "Benchmark my three VR projects against each other."
  • "Show me session metrics across all my projects."

Response for comparing projects includes

  • Side-by-side metrics for each project
  • Session counts and scene breakdowns
  • Average session durations
  • Engagement indicators (recent activity, active scenes)
  • Rankings by sessions and duration
  • Automated insights comparing project performance
  • Data quality indicators

Example workflow for comparing projects

  1. "Get my organization summary."
  2. "Compare all the projects in my organization."
  3. Review rankings and insights for performance differences

Parameters for comparing projects

Parameter Required Description
project_ids Yes Array of 2-5 project IDs to compare (integers)
metrics No Metrics to compare: sessions, duration, engagement, objectives. Default: all metrics

Available Tools

Tool Purpose
get_project_details Scene discovery, project metadata, and version information
compare_projects Compare metrics across multiple projects for benchmarking

intercom If you have a question or any feedback about our documentation please use the Intercom button (purple circle) in the lower right corner of any web page or join our Discord.