What is the Query API?
The Query API is a flexible analytics endpoint that allows you to query GUIDEcx data directly through the API. Instead of pulling one record at a time, the Query API lets you retrieve large sets of onboarding data for reporting, dashboards, integrations, and business intelligence tools.
This API is designed for teams that want deeper visibility into onboarding operations and need to connect GUIDEcx data with external systems such as BI platforms, internal dashboards, CRMs, or data warehouses.
What Can You Use the Query API For?
The Query API makes it easier to answer questions like:
Which projects are at risk?
How long does onboarding typically take?
Which tasks are commonly overdue?
What is the workload distribution across project managers?
How are customers responding to CSAT surveys?
How much time is being logged across projects?
Many teams use the Query API to power:
Executive dashboards
Custom reports
Revenue and forecasting analysis
Customer onboarding health tracking
Resource and utilization reporting
External BI tools like Tableau or Power BI
GUIDEcx’s reporting and BI tooling is built around giving organizations more access to operational onboarding data and analytics.
How the Query API Works
The Query API allows you to:
Select datasets
Filter results
Retrieve specific fields
Aggregate data
Build custom analytics queries
Rather than calling many individual endpoints, the Query API provides a more efficient way to retrieve structured reporting data in bulk.
This is especially useful for:
Automated reporting
Scheduled exports
Large-scale integrations
Data synchronization workflows
Available Data
The Query API can expose data related to many GUIDEcx entities, including:
Projects: Project status, timelines, owners, budgets, and health information.
Tasks: Task assignments, durations, completion dates, overdue metrics, and dependencies.
Customers: Customer-related onboarding data tied to projects and progress.
Time Tracking: Logged hours, billable time, and utilization reporting.
Surveys & CSAT: Survey invitations, responses, and satisfaction metrics.
Custom Fields & Properties: Project and task-level custom properties used throughout your onboarding workflows.
GUIDE 2.0 datasets were specifically expanded to support deeper analytics and reporting use cases.
Benefits of Using the Query API
Centralized Reporting: Bring GUIDEcx data into a single reporting environment alongside data from your CRM, PSA, or financial systems.
Better Operational Visibility: Identify onboarding bottlenecks, project risks, and process inefficiencies faster.
Custom Dashboards: Create dashboards tailored to your organization’s KPIs and onboarding metrics.
Automation & Integrations: Automate recurring reporting workflows and reduce manual exports.
Scalable Analytics: Query large datasets efficiently instead of managing multiple endpoint requests.
Who Typically Uses the Query API?
The Query API is commonly used by:
Operations teams
Technical administrators
Business intelligence analysts
Data engineers
Integration developers
Enterprise onboarding teams
If your team wants advanced reporting beyond standard dashboards, the Query API provides the flexibility to build exactly what you need.
Getting Started
To begin using the Query API:
Review the API documentation.
Generate your API credentials.
Test queries using Postman or your preferred API client.
Connect the API to your reporting or integration environment.
Build dashboards and workflows around your onboarding data.
You can explore the official API documentation here:
Need help building custom integrations or reporting workflows? Reach out to your CSM to connect with the GUIDEcx Technical Services team.