Skip to main content
GET
Fetch business activity metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json

Path Parameters

businessId
string
required

The UUID of the business to fetch metrics for

Query Parameters

start_date
string

Optional filter for the start of the activity window. Metrics will include data on or after this date. Accepts either an ISO 8601 date (YYYY-MM-DD) or date-time.

end_date
string

Optional filter for the end of the activity window. Metrics will include data up to and including this date. Accepts either an ISO 8601 date (YYYY-MM-DD) or date-time.

Response

Business activity summary with monthly breakdowns

months
object[]

Monthly activity summaries for a single business