latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Get subscriber events over time

Returns cursor-paginated subscriber event data for the authenticated creator over a specified time period.

This endpoint is an analytics time series, not a real-time audience snapshot:

  • newSubscribersCount = number of new subscription starts in the period bucket
  • cancelledSubscribersCount = number of subscription chain ends in the period bucket
  • total = cumulative net change from the beginning of the requested range (new - cancelled)

If you need a current audience count/list (for messaging or contact list UX), use Smart Lists endpoints (/chats/lists/smart and /chats/lists/smart/{uuid}) instead of this endpoint.

Data is aggregated daily with timezone-aware boundaries. When dates include timezone offsets, results are normalized to midnight in that timezone (expressed as UTC).

<Info> **Polling for real-time updates? Use a webhook instead.**

If you are calling this endpoint on a schedule to detect new activity, subscribe to the creator.subscription.activated, creator.subscription.deactivated webhook events instead — you'll get pushed updates in real time without polling. See the webhook documentation. </Info>

get/insights/subscribers

Query parameters

startDatestring date-time

Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z). Data is aggregated daily with timezone-aware boundaries. Time component is ignored for daily aggregation.

Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z). Data is aggregated daily with timezone-aware boundaries. Time component is ignored for daily aggregation.

endDatestring date-time

End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included. Data is aggregated daily with timezone-aware boundaries. Time component is ignored for daily aggregation.

End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included. Data is aggregated daily with timezone-aware boundaries. Time component is ignored for daily aggregation.

cursorstring

Cursor for pagination - If given, pass nextCursor to get the next page.

Cursor for pagination - If given, pass nextCursor to get the next page.

sizenumber

Number of items to return per page (1-50, default: 20). When omitted on a cursor request, the size from the previous page (carried in the cursor) is reused.

Number of items to return per page (1-50, default: 20). When omitted on a cursor request, the size from the previous page (carried in the cursor) is reused.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

Subscribers data with cursor pagination

nextCursorstring nullable required

Cursor for next page, null if no more data