Trial Links

Get Trial Link Stats

Returns cumulative totals plus daily and monthly time-series for a single trial link. Requires permission api_trial_links_read.

https://public-api.fansmetric.com

GET/v1/{account_id}/trial-links/{link_id}/stats

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.
link_id*integer
Trial link ID.

Query Parameters

date_startstring
Window start (UTC). Absent → unbounded.
date_endstring
Window end (UTC). Absent → unbounded.

Response Fields

data.summary.subs_totalinteger
Claims claimed inside the requested window.
data.summary.cumulative_subs_totalinteger
Claims claimed since the link's inception, up to date_end. Ignores date_start.
data.summary.revenue_totalstring
Net attributed revenue inside the window.
data.summary.cumulative_revenue_totalstring
Net attributed revenue since inception, up to date_end. Ignores date_start.
data.summary.spenders_totalinteger
Distinct spenders inside the window.
data.summary.last_scanned_atstring | null
When this link was last refreshed by the scraper.
data.daily_metrics[]array
Per-day buckets, UTC, sparse — only days with activity are emitted (no zero-filling).
data.daily_metrics[].timestampstring
Bucket start (YYYY-MM-DD, midnight UTC).
data.daily_metrics[].subsinteger
Claims claimed in the bucket. Incremental.
data.daily_metrics[].cumulative_subsinteger
Running total of claims from the link's first activity through this bucket — not from the window start.
data.daily_metrics[].revenuestring
Net revenue in the bucket. Incremental.
data.daily_metrics[].cumulative_revenuestring
Running total of revenue from the link's first activity through this bucket.
data.daily_metrics[].spendersinteger
Distinct spenders in the bucket.
data.monthly_metrics[]array
Per-month buckets. Same shape as daily_metrics[], aligned to the 1st of the month UTC.
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.summary.subs_total	integer	Claims claimed inside the requested window.
data.summary.cumulative_subs_total	integer	Claims claimed since the link's inception, up to `date_end`. Ignores `date_start`.
data.summary.revenue_total	string	Net attributed revenue inside the window.
data.summary.cumulative_revenue_total	string	Net attributed revenue since inception, up to `date_end`. Ignores `date_start`.
data.summary.spenders_total	integer	Distinct spenders inside the window.
data.summary.last_scanned_at	string \| null	When this link was last refreshed by the scraper.
data.daily_metrics[]	array	Per-day buckets, UTC, sparse — only days with activity are emitted (no zero-filling).
data.daily_metrics[].timestamp	string	Bucket start (`YYYY-MM-DD`, midnight UTC).
data.daily_metrics[].subs	integer	Claims claimed in the bucket. Incremental.
data.daily_metrics[].cumulative_subs	integer	Running total of claims from the link's first activity through this bucket — not from the window start.
data.daily_metrics[].revenue	string	Net revenue in the bucket. Incremental.
data.daily_metrics[].cumulative_revenue	string	Running total of revenue from the link's first activity through this bucket.
data.daily_metrics[].spenders	integer	Distinct spenders in the bucket.
data.monthly_metrics[]	array	Per-month buckets. Same shape as `daily_metrics[]`, aligned to the 1st of the month UTC.
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/trial-links/sample_link_id/stats?date_start=sample_date_start&date_end=sample_date_end" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"summary":{"subs_total":45
"cumulative_subs_total":45
"revenue_total":"245.50"
"cumulative_revenue_total":"245.50"
"spenders_total":6
"last_scanned_at":"2026-08-05T02:11:30Z"
}
"daily_metrics":[0:{"timestamp":"2026-07-31"
"subs":3
"cumulative_subs":30
"revenue":"12.50"
"cumulative_revenue":"180.30"
"spenders":1
}
1:{"timestamp":"2026-08-01"
"subs":2
"cumulative_subs":32
"revenue":"0.00"
"cumulative_revenue":"180.30"
"spenders":0
}
2:{"timestamp":"2026-08-02"
"subs":4
"cumulative_subs":36
"revenue":"38.20"
"cumulative_revenue":"218.50"
"spenders":2
}
]
"monthly_metrics":[0:{"timestamp":"2026-07-01"
"subs":30
"cumulative_subs":30
"revenue":"180.30"
"cumulative_revenue":"180.30"
"spenders":4
}
1:{"timestamp":"2026-08-01"
"subs":15
"cumulative_subs":45
"revenue":"65.20"
"cumulative_revenue":"245.50"
"spenders":2
}
]
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Delete Trial Link

Update Trial LinkFM