Skip to main content
GET
/
insights
/
spending
Get spending reversal data
curl --request GET \
  --url https://api.example.com/insights/spending \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>'
{
  "data": [
    {
      "date": "2024-01-15T00:00:00.000Z",
      "gross": -5000,
      "net": -4250,
      "currency": "USD",
      "source": "refund",
      "user": {
        "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "handle": "sarah-jones",
        "nickname": "SarahK",
        "displayName": "Sarah Jones",
        "isTopSpender": true,
        "avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
        "registeredAt": "2024-01-10T12:00:00.000Z"
      }
    },
    {
      "date": "2024-01-14T00:00:00.000Z",
      "gross": -2500,
      "net": -2125,
      "currency": "USD",
      "source": "chargeback",
      "user": {
        "uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "handle": "mike-smith",
        "nickname": null,
        "displayName": "Mike Smithly",
        "isTopSpender": false,
        "avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
        "registeredAt": "2024-01-10T12:00:00.000Z"
      }
    }
  ],
  "nextCursor": "eyJkYXRlIjoiMjAyNC0wMS0xNVQwMDowMDowMC4wMDBaIn0"
}
Required scope
  • read:insights — Access analytics, metrics, and insights data for performance tracking.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

​
X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Query Parameters

​
startDate
string<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).

​
endDate
string<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.

​
source
enum<string>[]

Comma-separated list of spending sources

The spending type filter

Available options:
all,
refund,
chargeback
​
cursor
string

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

​
size
number
default:20

Number of items to return per page (1-50, default: 20)

Required range: 1 <= x <= 50

Response

Spending reversal data with cursor pagination

​
data
object[]
required
​
nextCursor
string | null
required

Cursor for next page, null if no more data