Analytics

Returns hours, amount, costs, expenses, invoice totals, planned-invoice totals, and a monthly histogram aggregated across every project belonging to the client, plus per-project, per-task, per-reference, per-user, and per-team breakdowns. Invoice and planned-invoice totals include an internal / external split keyed by isInternal; individual invoice records are not included (use the project-level endpoints for that). Restricted to admins (canManageAllProjects).

Returns per-project rows of tracked hours, tracked amount, billed amount, billable hours, planned hours, and planned amount, sliced into monthly or weekly periods spanning [startDate, endDate]. Admins, users with canManageAllProjects, and PMs (canManageOwnProjects) / project members (canAccessOwnProjects) may call this endpoint; the latter only see projects they are assigned to.

Returns one entry per calendar month with per-project tracked duration, amount, billed amount, planned amount, planned-over-budget amount, and posted expenses. Requires canManageAllProjects, canAccessUsers, or admin.

Returns per-project roll-ups (hours, amount, costs, monthly histogram, invoices, planned invoices, planner data) for every project the caller can read. Invoice and planned-invoice payloads include an internal / external split keyed by isInternal. Filterable by project IDs and an optional date range. Requires canAccessOwnProjects, project-manager status on the targeted projects, or admin.

Returns budgets, time entries, expenses, invoices, planned invoices, costs, and a monthly histogram for one project, plus breakdowns by user, task, reference, and team. Invoice and planned-invoice payloads include an internal / external split keyed by isInternal. The caller must be able to read the project (404 otherwise) and either manage all projects, be a project manager on it, or have canAccessOwnProjects (400 otherwise).

Returns hours-only roll-up for one project, intended for users who can see the project but not full cost / amount data. The endpoint is gated by the account-level activateProjectAnalyticsForUser setting; the request returns 400 if it is disabled. Returns 404 if the project is not visible to the caller.

Returns hours, amount, costs, expenses, invoice totals, planned-invoice totals, and a monthly histogram aggregated across every sub-project under the super-project, plus per-project, per-task, per-reference, per-user, and per-team breakdowns. Invoice and planned-invoice totals include an internal / external split keyed by isInternal; individual invoice records are not included (use the project-level endpoints for that). Restricted to admins (canManageAllProjects) or users who are project manager on every sub-project.

Returns hours, amount, costs, and a per-group breakdown of time entries within a date window, filterable by project, client, task, user, team, tag, invoice, reference, validation status, and billable / billed flags. The shape of groupedBy follows the groupBy query parameter.

For every user the caller is allowed to see, returns tracked time, worktime, planner data, and expected hours rolled up into period buckets (day / week / monthweek / month / year). Useful for utilisation views, planned-vs-actual dashboards, and capacity reports. Requires canAccessUsers, or limitedTeamStaffAccess on at least one team — in the latter case the response is restricted to users assigned to those teams.

Returns staff-cost totals for a date window or for each month of a year. The response shape switches with aggregation_type (or with the /monthly/{year} route): aggregated returns combined current-vs-previous totals, employees and freelancers return per-user current totals plus a previous total, and the monthly route returns 12 monthly rows. Costs are computed from useremployment (monthly remuneration × employer contribution prorated by active days) and time-entry hours × hourly remuneration. Without user, requires canAccessProjectCosts or canAccessRemunerations. With user, requires canAccessRemunerations (and additionally canAccessAdminRemunerations to see costs of admin users).

Returns staff-cost totals for a date window or for each month of a year. The response shape switches with aggregation_type (or with the /monthly/{year} route): aggregated returns combined current-vs-previous totals, employees and freelancers return per-user current totals plus a previous total, and the monthly route returns 12 monthly rows. Costs are computed from useremployment (monthly remuneration × employer contribution prorated by active days) and time-entry hours × hourly remuneration. Without user, requires canAccessProjectCosts or canAccessRemunerations. With user, requires canAccessRemunerations (and additionally canAccessAdminRemunerations to see costs of admin users).

Returns billable revenue derived from time-entry duration × hourly rate, split by month. With the /monthly/{year} route, the response is normalised to a 12-entry array for the given year. Without the path year, the raw rows from the underlying query (or monthlyuserrevenue cache) are returned. The endpoint distinguishes total revenue from in-budget revenue, so callers can see how much was logged after a project hit its budget. Restricted to admins, users with canManageAllProjects, or PMs who have limitedTeamStaffAccess on the team the queried user belongs to.

Returns billable revenue derived from time-entry duration × hourly rate, split by month. With the /monthly/{year} route, the response is normalised to a 12-entry array for the given year. Without the path year, the raw rows from the underlying query (or monthlyuserrevenue cache) are returned. The endpoint distinguishes total revenue from in-budget revenue, so callers can see how much was logged after a project hit its budget. Restricted to admins, users with canManageAllProjects, or PMs who have limitedTeamStaffAccess on the team the queried user belongs to.