GET
/
v1
/
activity
/
businesses
/
{businessId}
Fetch business activity summary
curl --request GET \
  --url https://sandbox.layerfi.com/v1/activity/businesses/{businessId} \
  --header 'Authorization: Bearer <token>'
[
  {
    "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "legal_name": "ACME Inc.",
    "sms_sent": 400,
    "sms_received": 400,
    "sms_sent_last_30": 40,
    "sms_received_last_30": 40,
    "categorized_last_month": 60,
    "uncategorized_last_month": 5,
    "categorized_by_api_last_month": 40,
    "categorized_by_sms_last_month": 20,
    "categorized_pct_last_month": 0.92,
    "categorized_this_month": 30,
    "uncategorized_this_month": 10,
    "categorized_by_api_this_month": 10,
    "categorized_by_sms_this_month": 20,
    "categorized_pct_this_month": 0.75,
    "days_since_last_activity": 1,
    "current_sms_queue_length": 5
  }
]

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

Response

​
businessId
string<uuid>

The ID of the business this activity summary is for

​
legal_name
string

The legal name of the business this summary is for

Example:

"ACME Inc."

​
sms_sent
integer

The number of SMS messages sent by the business

Example:

400

​
sms_received
integer

The number of SMS messages received by the business

Example:

400

​
sms_sent_last_30
integer

The number of SMS messages sent by the business within the last 30 days

Example:

40

​
sms_received_last_30
integer

The number of SMS messages received by the business within the last 30 days

Example:

40

​
categorized_last_month
integer

The number of transactions for the business last month that were categorized

Example:

60

​
uncategorized_last_month
integer

The number of transactions for the business last month that were not categorized

Example:

5

​
categorized_by_api_last_month
integer

The number of transactions for the business last month that were categorized via Layer's API

Example:

40

​
categorized_by_sms_last_month
integer

The number of transactions for the business last month that were categorized via Layer's SMS flows

Example:

20

​
categorized_pct_last_month
number

The percent of transactions for the business last month that were categorized

Example:

0.92

​
categorized_this_month
integer

The number of transactions for the business this month that have been categorized

Example:

30

​
uncategorized_this_month
integer

The number of transactions for the business this month that have not been categorized

Example:

10

​
categorized_by_api_this_month
integer

The number of transactions for the business this month that have been categorized via Layer's API

Example:

10

​
categorized_by_sms_this_month
integer

The number of transactions for the business this month that have been categorized via Layer's SMS flows

Example:

20

​
categorized_pct_this_month
number

The percent of transactions for the business last month that were categorized

Example:

0.75

​
days_since_last_activity
integer

The number of days since the business was last active (sent an SMS, categorized a transaction)

Example:

1

​
current_sms_queue_length
integer

The number of transactions ready for categorization via SMS

Example:

5