Skip to content

Objective Queries

Objective queries let you explore the goals and success metrics configured for your XR applications, analyze their complexity, and review performance results.

Tips

  • Start with the list: Use get_project_objectives first to understand what objectives exist
  • Quick checks: Use get_project_objectives_count when you just need to verify objectives are configured
  • Complexity audits: Run get_objective_components_analysis periodically to ensure your objectives aren't overly complex
  • Performance reviews: Use get_objective_results to identify which objectives need attention
  • Follow-up queries: "Why might users be failing this objective?" can help identify potential UX issues

Get project objectives

Returns all objectives configured for a project, including their names, descriptions, and component structure. Use this to understand what success looks like in your XR application.

Sample queries for project objectives

  • "What objectives are configured in project 123?"
  • "Show me the goals for my training application."
  • "List all objectives and their descriptions."
  • "What am I measuring in this project?"

Response for project objectives includes

  • List of all objectives with IDs
  • Objective names and descriptions
  • Component breakdown for each objective
  • Configuration details

Parameters for project objectives

Parameter Required Description
project_id Yes The numeric project ID

Get project objectives count

Returns a quick count of objectives in a project without fetching full details. Useful for a high-level overview or when you just need to know if objectives are configured.

Sample queries for project objectives count

  • "How many objectives do I have?"
  • "Does project 123 have any objectives configured?"
  • "Give me a quick count of objectives."

Response for project objectives count includes

  • Total count of objectives
  • Quick confirmation of objective presence

Parameters for project objectives count

Parameter Required Description
project_id Yes The numeric project ID

Get objective results

Returns success and failure metrics for objectives, showing how users are performing against your defined goals.

Sample queries for objective results

  • "What is the success rate for my objectives?"
  • "Which objective has the lowest completion rate?"
  • "Show me objective performance in project 123."
  • "How are users doing on the training objectives?"
  • "What's the failure rate for the safety checklist objective?"

Response for objective results includes

  • Success/failure counts per objective
  • Completion percentages
  • Performance trends
  • Comparative analysis across objectives

Parameters for objective results

Parameter Required Description
project_id Yes The numeric project ID

Get objective components analysis

Analyzes the complexity of your objective configurations, helping you understand how sophisticated your success measurements are.

Sample queries for objective components analysis

  • "How complex are my objective configurations?"
  • "Analyze the structure of my objectives."
  • "What components make up my objectives?"
  • "Show me the breakdown of objective complexity."

Response for objective components analysis includes

  • Component type distribution
  • Complexity scoring
  • Configuration patterns
  • Recommendations for improvement

Parameters for objective components analysis

Parameter Required Description
project_id Yes The numeric project ID

Available Tools

Tool Purpose
get_project_objectives List objectives and their configuration details
get_project_objectives_count Quick count of objectives (lightweight)
get_objective_components_analysis Analyze complexity of objective configurations
get_objective_results Success/failure metrics and performance data

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.