Chat

Chat Overview

Returns the 11-stat chat performance headline for an account over a date window — the current value, the previous window's value, and the percent change for each stat. Pair with Chat Chart to draw a trend line for any single stat. Requires permission api_chat_read_overview.

https://public-api.fansmetric.com

GET/v1/{account_id}/chat/overview

API keyBearer

Authorization

default

AuthorizationBearer <token>

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

In: header

Path Parameters

account_id*integer
OnlyFans numeric account ID.

Query Parameters

fromstring
Window start (UTC). Default 30 days ago. Accepts ISO 8601 (2026-07-08T00:00:00Z) or relative shorthand (-30days, -24h).
tostring
Window end (UTC). Default now. Must be after from.
revenue_typestring
net (default) or gross. Applies to tips, messages, chatearnings, averagetip, averagemessage. Count stats ignore this. monthlychatearnings and chatafv are always net.

Response Fields

data.metrics[]array
The 11 stats, always in the same fixed order — see Behavior below for the list.
data.metrics[].statstring
Machine-readable stat key.
data.metrics[].statHumanstring
Human-readable label (e.g. "Tips ($)").
data.metrics[].descriptionstring
One-line explanation of the stat.
data.metrics[].currentnumber
Value over the requested window.
data.metrics[].previousnumber
Value over the same-length window immediately before from.
data.metrics[].changenumber
(current − previous) / previous as a decimal (0.25 = +25%). 0 when previous is 0.
data.metrics[].symbolstring
$, %, or empty (for count stats).
data.metrics[].valueIsIntegerboolean
Render hint — whether to drop decimals.
data.metrics[].symbolFirstboolean
Render hint — put symbol before the value ($100) vs after (100%).
data.metrics[].positiveIsGoodboolean
Render hint — colour a positive change as good vs bad.
data.fromstring
Resolved window start (RFC 3339 UTC).
data.tostring
Resolved window end (RFC 3339 UTC).
data.revenueTypestring
Echoes the effective revenue variant.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_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.metrics[]	array	The 11 stats, always in the same fixed order — see Behavior below for the list.
data.metrics[].stat	string	Machine-readable stat key.
data.metrics[].statHuman	string	Human-readable label (e.g. `"Tips ($)"`).
data.metrics[].description	string	One-line explanation of the stat.
data.metrics[].current	number	Value over the requested window.
data.metrics[].previous	number	Value over the same-length window immediately before `from`.
data.metrics[].change	number	`(current − previous) / previous` as a decimal (0.25 = +25%). `0` when `previous` is 0.
data.metrics[].symbol	string	`$`, `%`, or empty (for count stats).
data.metrics[].valueIsInteger	boolean	Render hint — whether to drop decimals.
data.metrics[].symbolFirst	boolean	Render hint — put `symbol` before the value (`$100`) vs after (`100%`).
data.metrics[].positiveIsGood	boolean	Render hint — colour a positive `change` as good vs bad.
data.from	string	Resolved window start (RFC 3339 UTC).
data.to	string	Resolved window end (RFC 3339 UTC).
data.revenueType	string	Echoes the effective revenue variant.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_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 GET "https://public-api.fansmetric.com/v1/100000001/chat/overview?from=sample_from&to=sample_to&revenue_type=sample_revenue_type" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"metrics":[0:{"stat":"outgoingmessages"
"statHuman":"Outgoing Messages"
"description":"The number of outgoing messages sent by your chatters."
"current":48210
"previous":41805
"change":0.1532
"symbol":""
"valueIsInteger":true
"symbolFirst":true
"positiveIsGood":true
}
1:{"stat":"chatearnings"
"statHuman":"Chat Earnings"
"description":"Earnings from tips and PPV message unlocks for the window."
"current":82441.28
"previous":74991.1
"change":0.0993
"symbol":"$"
"valueIsInteger":false
"symbolFirst":true
"positiveIsGood":true
}
2:{"stat":"tips"
"statHuman":"Tips ($)"
"description":"Earnings from tips for the window."
"current":21440.16
"previous":19052.32
"change":0.1253
"symbol":"$"
"valueIsInteger":false
"symbolFirst":true
"positiveIsGood":true
}
]
"from":"2026-07-11T00:00:00Z"
"to":"2026-08-10T00:00:00Z"
"revenueType":"net"
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

List All Earnings

Chat Chart