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
    }
  ]
}

GET

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

Show child attributes

months.month

string

The month in YYYY-MM format

Example:

"2024-01"

months.sms_sent

integer

Number of SMS messages sent by this business in this month

Example:

5

months.sms_received

integer

Number of SMS messages received by this business in this month

Example:

3

months.categorized_transactions

integer

Number of transactions categorized in this month

Example:

10

months.uncategorized_transactions

integer

Number of transactions that remain uncategorized in this month

Example:

2

months.categorized_by_api

integer

Number of transactions categorized via Layer's API in this month

Example:

7

months.categorized_by_sms

integer

Number of transactions categorized via Layer's SMS flows in this month

Example:

3

months.categorization_pct

number

The fraction of transactions that were categorized this month (0-1)

Example:

0.83

months.active_days

integer

Number of days in this month where the business had SMS or categorization activity

Example:

15

Fetch business activities Fetch Quickbooks configuration

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Fetch business activity metrics

Authorizations

Headers

Path Parameters

Query Parameters

Response