Skip to main content
GET
/
v2
/
activity
/
businesses
/
{businessId}
Fetch business activity metrics
curl --request GET \
  --url https://sandbox.layerfi.com/v2/activity/businesses/{businessId} \
  --header 'Authorization: Bearer <token>'
{
  "months": [
    {
      "month": "2024-01",
      "sms_sent": 5,
      "sms_received": 3,
      "categorized_transactions": 10,
      "uncategorized_transactions": 2,
      "categorized_by_api": 7,
      "categorized_by_sms": 3,
      "categorization_pct": 0.83,
      "active_days": 15
    }
  ]
}

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