Get project insights data in structured JSON format
What are Project Insights? Project Insights provides detailed analysis of working hours spent on company projects over time. This endpoint returns data that can be visualized as charts or exported to Excel, showing how time is allocated across projects, team members, task types, and individual tasks.
What data is returned: The response includes two “sheets” of data in JSON format (matching the Excel export structure):
- Summary sheet: Wide format (pivot table style) with periods as rows and breakdown categories as columns. Perfect for quick overview and visual chart generation.
- Detailed sheet: Long format (normalized/tidy data) with one row per period/breakdown combination. Ideal for further analysis, pivot tables, and BI tools.
Supported analysis options:
- Project selection: Analyze single project or compare multiple projects side-by-side
- Date range: Auto-calculated from time log data if not provided, or specify custom range
- Model selection:
- timeSeries: Shows data over time periods (trends and comparisons)
- total: Shows aggregated totals across entire period (distribution analysis)
- Period granularity: Group data by months or weeks
- Breakdown options:
- none: No breakdown (total hours only)
- byUser: Breakdown by team member
- byTaskType: Breakdown by task category
- byTask: Breakdown by individual task
- byProject: Breakdown by project (only for multiple projects)
- View style (single project time series only):
- trend: Cumulative values showing progress over time (ladder-style bars)
- periodComparison: Period-by-period values (non-cumulative bars)
- Display style (multiple projects time series only):
- groups: Separate lines/bars for each project (comparison view)
- stacks: Stacked bars showing combined effort (aggregate view)
Data structure:
- Headers and titles are fully localized based on user’s language preference
- All entity names (users, projects, tasks) are human-readable (never UUIDs)
- Numeric values include proper formatting (2 decimal places)
- Metadata includes query execution time and data processing statistics
Use cases:
- Generate visual charts showing project time allocation trends
- Export to Excel for detailed analysis and reporting
- Track team member contributions over time
- Analyze task type distribution across projects
- Monitor project progress against budgets and estimates
/insights/project-chartAuthorizationOAuth2 access token · headerrequiredapi:readAuthorizationBearer token (JWT) · headerrequiredprojectIdsstring[]requiredArray of project UUIDs to analyze. Can select single project for detailed analysis or multiple projects for comparison. At least one project is required.
startDatestringStart date for the analysis period in ISO 8601 format (YYYY-MM-DD). If not provided, automatically calculated from the earliest time log entry in the selected projects. Used to determine the beginning of the time series or total aggregation period.
endDatestringEnd date for the analysis period in ISO 8601 format (YYYY-MM-DD). If not provided, automatically calculated from the latest time log entry in the selected projects. Must be after startDate if both are provided. Used to determine the end of the time series or total aggregation period.
modelstringrequiredChart model type determining how data is aggregated and displayed. timeSeries shows data over time periods (trends and comparisons), while total shows aggregated totals across the entire period (distribution analysis). Time series is ideal for tracking progress over time, while total is better for understanding overall distribution.
timeSeriestotalperiodstringrequiredTime period granularity for grouping data. months groups data by calendar month, weeks groups data by week. This determines the x-axis intervals in time series charts and affects how data is aggregated. Months provide broader trends, weeks provide more detailed granularity.
monthsweeksbreakdownstringOptional breakdown dimension for segmenting the data. none shows total hours without segmentation. byUser breaks down by team member, byTaskType by task category, byTask by individual task, and byProject by project (only available when multiple projects are selected). Breakdowns enable detailed analysis of how time is distributed across different dimensions.
nonebyUserbyTaskTypebyTaskbyProjectbyValueGroupsviewStylestringView style for single project time series charts. trend shows cumulative values (ladder-style bars showing progress from start to each period), while periodComparison shows period-by-period values (non-cumulative bars comparing each period independently). Only applicable when a single project is selected and model is timeSeries.
trendperiodComparisondisplayStylestringDisplay style for multiple projects time series charts. groups shows separate lines/bars for each project (comparison view), while stacks shows stacked bars combining all projects (aggregate view). Only applicable when multiple projects are selected and model is timeSeries.
groupsstacksProject insights data in structured JSON format with summary and detailed sheets
detailedobjectrequiredDetailed sheet data (long/tidy format, normalized). One row per period/breakdown combination.
Show propertiesHide properties
headersstring[]requiredColumn headers for the sheet
rowsobject[]requiredData rows as array of objects, where keys match headers. Each row represents one data point.
titleobjectrequiredSheet title information with main title and subtitle
metadataobjectrequiredMetadata about the query execution and results
summaryobjectrequiredSummary sheet data (wide/matrix format, like pivot table). Periods as rows, breakdown categories as columns.
Show propertiesHide properties
headersstring[]requiredColumn headers for the sheet
rowsobject[]requiredData rows as array of objects, where keys match headers. Each row represents one data point.
titleobjectrequiredSheet title information with main title and subtitle
Invalid request parameters (invalid dates, enum values, etc.)
Unauthorized - Invalid or missing authentication token
User does not have permission to view project insights (requires Insights.viewProjectInsights)
One or more project IDs not found or user does not have access to them