Chatters

Chatter Report

Returns a paginated per-chatter aggregate table across the window, plus an aggregate totals row that spans every chatter (not just the current page). Companion to Compare Chatters — same data, tabular shape instead of time-series. Requires permission api_chat_chatters_report.

https://public-api.fansmetric.com

POST/v1/chatters/report

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Request Body

application/json

account_ids*array
Array of OnlyFans numeric account IDs (as strings). At least one. Every ID must belong to your org.
fromstring
Window start (UTC). Default 30 days ago.
tostring
Window end (UTC). Default now. Must be after from.
team_idsarray
Array of team UUIDs. Restricts the report to users in any of these teams.
limitinteger
Page size. Default 100, max 500.
offsetinteger
Rows to skip. Default 0.
compare_to_previousstring
true (default) to include *_prev fields on each row for the same-length window immediately before from. Set false for a faster response.
skip_revenue_statsstring
true to return only hours_worked and messages_sent per row — no revenue, PPV, tips, or previous-window compare. Use for fast roster listings. Default false.

Response Fields

data.chatters[]array
Rows in this page, sorted by all_earnings descending.
data.chatters[].idstring
FansMetric user UUID.
data.chatters[].emailstring
Sign-in email.
data.chatters[].namestring
Display name.
data.chatters[].rolesarray
Roles (id, name, color).
data.chatters[].hours_workedinteger
Hours the chatter was clocked in during the window.
data.chatters[].messages_sentinteger
Total messages sent (text + PPV).
data.chatters[].unique_messaged_fansinteger
Distinct fans the chatter messaged.
data.chatters[].unique_fansinteger
Distinct fans that responded to or interacted with this chatter.
data.chatters[].all_earningsnumber
Total attributed revenue (tips_revenue + ppvs_revenue, net). In the account's payout currency.
data.chatters[].tips_revenuenumber
Net tips revenue attributed to this chatter.
data.chatters[].tips_countinteger
Number of tips.
data.chatters[].ppvs_revenuenumber
Net revenue from unlocked PPVs attributed to this chatter.
data.chatters[].ppvs_countinteger
Number of PPV messages sent.
data.chatters[].unlocked_ppvs_countinteger
Number of PPVs that were unlocked.
data.chatters[].golden_rationumber
(ppvs_count / messages_sent) × 100, rounded to 2 decimals. 0 when messages_sent is 0.
data.chatters[].unlock_rationumber
(unlocked_ppvs_count / ppvs_count) × 100, rounded to 2 decimals. 0 when ppvs_count is 0.
data.chatters[].chargebacks_totalnumber
Sum of chargeback amounts on this chatter's transactions.
data.chatters[].chargebacks_countinteger
Number of chargebacks.
data.chatters[].<field>_prevany
Every current-window field is repeated with a _prev suffix for the same-length window immediately before from. Present only when compare_to_previous=true.
data.aggregateobject
Totals across every row in the result set (not just the current page). Same fields as data.chatters[] minus identity. Ratios are re-derived from the summed numerators/denominators.
data.totalinteger
Total rows across all pages.
data.limitinteger
Effective page size.
data.offsetinteger
Effective offset.
data.fromstring
Resolved window start (RFC 3339 UTC).
data.tostring
Resolved window end (RFC 3339 UTC).
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_pagination.next_pagestring
Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data.chatters[]	array	Rows in this page, sorted by `all_earnings` descending.
data.chatters[].id	string	FansMetric user UUID.
data.chatters[].email	string	Sign-in email.
data.chatters[].name	string	Display name.
data.chatters[].roles	array	Roles (`id`, `name`, `color`).
data.chatters[].hours_worked	integer	Hours the chatter was clocked in during the window.
data.chatters[].messages_sent	integer	Total messages sent (text + PPV).
data.chatters[].unique_messaged_fans	integer	Distinct fans the chatter messaged.
data.chatters[].unique_fans	integer	Distinct fans that responded to or interacted with this chatter.
data.chatters[].all_earnings	number	Total attributed revenue (`tips_revenue + ppvs_revenue`, net). In the account's payout currency.
data.chatters[].tips_revenue	number	Net tips revenue attributed to this chatter.
data.chatters[].tips_count	integer	Number of tips.
data.chatters[].ppvs_revenue	number	Net revenue from unlocked PPVs attributed to this chatter.
data.chatters[].ppvs_count	integer	Number of PPV messages sent.
data.chatters[].unlocked_ppvs_count	integer	Number of PPVs that were unlocked.
data.chatters[].golden_ratio	number	`(ppvs_count / messages_sent) × 100`, rounded to 2 decimals. `0` when `messages_sent` is 0.
data.chatters[].unlock_ratio	number	`(unlocked_ppvs_count / ppvs_count) × 100`, rounded to 2 decimals. `0` when `ppvs_count` is 0.
data.chatters[].chargebacks_total	number	Sum of chargeback amounts on this chatter's transactions.
data.chatters[].chargebacks_count	integer	Number of chargebacks.
data.chatters[].<field>_prev	any	Every current-window field is repeated with a `_prev` suffix for the same-length window immediately before `from`. Present only when `compare_to_previous=true`.
data.aggregate	object	Totals across every row in the result set (not just the current page). Same fields as `data.chatters[]` minus identity. Ratios are re-derived from the summed numerators/denominators.
data.total	integer	Total rows across all pages.
data.limit	integer	Effective page size.
data.offset	integer	Effective offset.
data.from	string	Resolved window start (RFC 3339 UTC).
data.to	string	Resolved window end (RFC 3339 UTC).
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_pagination.next_page	string	Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request POST "https://public-api.fansmetric.com/v1/chatters/report" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "from": "2026-07-11T00:00:00Z",
  "to":   "2026-08-10T23:59:59Z",
  "account_ids": ["100000001", "100000002"],
  "limit":  100,
  "offset": 0,
  "compare_to_previous": true
}'

Response

200

{"data":{"chatters":[0:{"id":"b7a9e0f1-2fa4-4d0b-9c2a-6c4d0b41f2c7"
"email":"alex@example.com"
"name":"Alex Chen"
"roles":[0:{"id":"r_02"
"name":"Team Lead"
"color":"#3b82f6"
}
]
"hours_worked":168
"messages_sent":9421
"unique_messaged_fans":812
"unique_fans":744
"all_earnings":38214.72
"tips_revenue":10442.1
"tips_count":321
"ppvs_revenue":27772.62
"ppvs_count":1520
"unlocked_ppvs_count":842
"golden_ratio":16.13
"unlock_ratio":55.39
"chargebacks_total":124.5
"chargebacks_count":3
"hours_worked_prev":160
"messages_sent_prev":8801
"unique_messaged_fans_prev":780
"unique_fans_prev":701
"all_earnings_prev":35218.9
"tips_revenue_prev":9812.2
"tips_count_prev":302
"ppvs_revenue_prev":25406.7
"ppvs_count_prev":1441
"unlocked_ppvs_count_prev":790
"golden_ratio_prev":16.37
"unlock_ratio_prev":54.82
"chargebacks_total_prev":98
"chargebacks_count_prev":2
}
1:{"id":"c5d6e7f8-9012-3456-7890-abcdef012345"
"email":"jordan@example.com"
"name":"Jordan Rivera"
"roles":[0:{"id":"r_01"
"name":"Chatter"
"color":"#22c55e"
}
]
"hours_worked":120
"messages_sent":6540
"unique_messaged_fans":512
"unique_fans":488
"all_earnings":21445.1
"tips_revenue":5210.3
"tips_count":184
"ppvs_revenue":16234.8
"ppvs_count":980
"unlocked_ppvs_count":541
"golden_ratio":14.98
"unlock_ratio":55.2
"chargebacks_total":0
"chargebacks_count":0
}
]
"aggregate":{"hours_worked":288
"messages_sent":15961
"unique_messaged_fans":1324
"unique_fans":1232
"all_earnings":59659.82
"tips_revenue":15652.4
"tips_count":505
"ppvs_revenue":44007.42
"ppvs_count":2500
"unlocked_ppvs_count":1383
"golden_ratio":15.66
"unlock_ratio":55.32
"chargebacks_total":124.5
"chargebacks_count":3
}
"total":47
"limit":100
"offset":0
"from":"2026-07-11T00:00:00Z"
"to":"2026-08-10T23:59:59Z"
}
"_pagination":{"next_page":null
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Compare Chatters

Top Highlights