Show metrics (beta)

Get a report for a project containing data from the Project Overview Report. Tentative projects are included: as in the in-app report, days scheduled before today are treated as not having materialised and are excluded from a tentative project's metrics. This endpoint is available only to Advanced Plan users, and the beta is currently closed. Please contact [email protected] if you'd like to join the waiting list.

Path Params
integer
required
Query Params
date

The start date for the report. For monthly reports, this must be the first day of the month. For weekly reports, this must be a Monday. For quarterly reports, this must be the first day of the quarter. Format: YYYY-MM-DD

string
enum

The time interval at which to split the metrics on the report. A monthly report made in June, for instance, will show revenue for June, July, August, and September. If not provided, the report will be for the Overview report (all inclusive).

Allowed:
Headers
enum
required
Defaults to 1.0.0
Allowed:
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json