Objective Queries & Management

Objective tools let you explore the goals and success metrics configured for your XR applications, analyze their complexity, review performance results — and create, edit, or delete objectives directly from your AI assistant.

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
• Dry runs: Creating, editing, and deleting always preview what will happen first; nothing changes until you confirm
• Write access: Objective changes require an organization-admin or project-admin role — read-only API keys can view but not change objectives

Objective edits follow two different paths — metadata applies instantly, but changing the success logic re-scores past sessions asynchronously:

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

Tool name: get_project_objectives

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

Tool name: get_project_objectives_count

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

Tool name: get_objective_results

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

Tool name: get_objective_components_analysis

Create an objective

Creates a new objective from gaze, fixation, and event step conditions. Creating an objective triggers re-evaluation of up to ~30 days of past sessions, so the tool previews the change and asks for confirmation first.

Sample queries for creating an objective

• "Create an objective called 'Safety Check' where users must look at the fire extinguisher and trigger the alarm_pulled event."
• "Add a training objective with three sequential steps."

Response for creating an objective includes

• The new objective's ID and version
• A note that past sessions are being re-scored asynchronously (this can take minutes to hours)

Parameters for creating an objective

Tool name: create_objective

Update an objective

Edits an objective's name, description, or enabled status (applies immediately), and/or replaces its step logic. Changing steps creates a new version and re-scores past sessions, so that path previews first and requires confirmation.

Sample queries for updating an objective

• "Rename objective 42 to 'Onboarding Complete'."
• "Disable the tutorial objective."
• "Change the safety objective so the gaze step requires at least 3 seconds."

Parameters for updating an objective

Tool name: update_objective

Delete an objective

Permanently deletes an objective and all of its versions. This cascades and cannot be undone, so the tool previews exactly what will be removed and requires confirmation.

Sample queries for deleting an objective

• "Delete the obsolete tutorial objective."
• "Remove objective 42 from project 123."

Parameters for deleting an objective

Tool name: delete_objective

Available Tools

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.