Skip to content
Hoursmith Docs
APIReferenceReports

Dashboard overview

Dashboard overview. The dashboard snapshot: hours for the 7 days ending today (caller's timezone) with the trend against the prior 7 days, active projects and the caller's own assigned open tasks (tasks of archived projects are left out, and a Member's count reads their current project access, so the tasks of a project they were removed from no longer count). Owner/Admin/Manager responses are workspace-wide and add unbilled and outstanding amounts per currency; Members get only their own hours on their projects and no money. Any role; no plan beyond API access. Takes no parameters. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).

GET
/reports/overview

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reports/overview"
{  "data": {    "today": "2019-08-24",    "timezone": "string",    "scope": "self",    "last7Days": {      "from": "2019-08-24",      "to": "2019-08-24",      "totalSeconds": 0,      "billableSeconds": 0,      "nonBillableSeconds": 0,      "billablePercent": 0,      "previous7DaysSeconds": 0,      "trendPercent": 0,      "days": [        {          "date": "2019-08-24",          "totalSeconds": 0,          "billableSeconds": 0,          "nonBillableSeconds": 0        }      ]    },    "activeProjects": 0,    "myTasks": {      "open": 0,      "dueWithin7Days": 0,      "overdue": 0    },    "unbilled": {      "roundedHours": "string",      "byCurrency": [        {          "currency": "str",          "amount": "string",          "hourlyAmount": "string",          "fixedFeeAmount": "string",          "expenseAmount": "string"        }      ]    },    "outstanding": {      "invoiceCount": 0,      "byCurrency": [        {          "currency": "str",          "amount": "string",          "invoiceCount": 0        }      ]    }  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
Was this page helpful?

Receivables summary

Accounts receivable per currency: outstanding (SENT invoices' total minus amount paid), overdue (due date before today in the caller's timezone), drafts, paid this month (net received principal by payment date, caller's calendar month) and aging buckets, plus the largest balances per client (max 50 rows). Owner, Admin or Manager only: a Member token gets 403. Plan: Studio or Agency (reports); otherwise 402. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).

Project budget and financials

Budget consumption and billing status for one project. Every role that can see the project gets tracked time and the hours budget; Owner/Admin/Manager responses add the amount budget and unbilled/billed/fixed-fee amounts in the client currency (omitted for Members). For HOURLY projects, unbilledHours and unbilledAmount are billable, uninvoiced, stopped time (a running timer is left out), each entry rounded up to the quarter hour; billedAmount is SENT and PAID invoice lines in the project's current currency (lines billed in another currency are listed in billedOtherCurrencies, never added); the amount budget's used also counts DRAFT invoice lines. Archived projects are included. No plan beyond API access. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).