Skip to main content
GET
Get business report summary

Authorizations

Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Headers

Privy-Account-Id
string

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Query Parameters

period
enum<string>
default:last_30_days

The date range to report over, resolved in the account's time zone. Pass custom together with start_date and end_date.

Available options:
last_7_days,
last_30_days,
last_90_days,
this_month,
last_month,
custom
start_date
string<date>

Inclusive start of a custom period (ISO 8601 date). Required when period=custom, ignored otherwise.

end_date
string<date>

Inclusive end of a custom period (ISO 8601 date). Required when period=custom, ignored otherwise. Custom periods are capped at 366 days.

compare
enum<string>

Pass previous_period to include previous_value, change and change_type on every metric and a comparison_period block. Any other value is rejected.

Available options:
previous_period

Response

The business's performance rollup over the resolved period.

data
object