GET
/
api
/
v2
/
get-ppv-statistics
Get PPV Statistics
curl --request GET \
  --url https://onlyautomator.com/api/v2/get-ppv-statistics \
  --header 'Authorization: Bearer <token>' \
  --header 'username: <username>'
{
  "status": "success",
  "data": [
    {
      "id": "ppv_92b3c1d4-5678-9012-ijkl-456789abcdef",
      "timestamp": "2023-03-10T18:30:00Z",
      "price": 4.99,
      "buyerCount": 42,
      "openRate": 76.5,
      "conversionRate": 12.4,
      "revenue": 209.58,
      "messageType": "video",
      "recipientCount": 340
    }
  ]
}
Retrieves statistics and performance metrics for pay-per-view (PPV) messages sent to subscribers.

​
Endpoint

GET /api/v2/get-ppv-statistics

​
Authentication

This endpoint requires authentication using a valid JWT token representing a valid user session managed by Supabase Auth (cookies).Include the token in the Authorization header as a Bearer token:
Authorization: Bearer <your_jwt_token>
The JWT token is obtained when connecting the account through the extension, or automatically handled by the browser session.Testing Note: Due to the requirement for a live user session, this endpoint cannot be successfully tested directly using the ‘Send’ button in this documentation with a static token.To test:
  1. Call this endpoint from your web application after logging in.
  2. Use curl or a similar tool with a valid, current user JWT obtained from your browser’s session after logging in.
Retrieving JWT Token for Testing: To test endpoints requiring a user session with tools like curl, you need the JWT access token stored by Supabase Auth in your browser.
  1. Log in to your application normally in your browser.
  2. Open Developer Tools (usually F12).
  3. Go to the Application tab (it might be called Storage in Firefox).
  4. Under the Storage section, find Cookies and select your application’s domain (e.g., http://localhost:3000 or https://onlyautomator.com).
  5. Look for a cookie named similar to sb-access-token (the exact name might vary slightly based on Supabase configuration).
  6. Copy the entire value of this cookie. This is your Bearer token.
  7. Use this copied value in the Authorization: Bearer <your_copied_token> header for your curl or other API tool requests.
Note: This token has a limited lifetime and you’ll need to copy a fresh one after it expires.

​
Request Headers

​
Authorization
string
required
Bearer token for authentication. Format: Bearer YOUR_JWT_TOKEN
​
Content-Type
string
required
Must be set to application/json
​
username
string
required
OnlyFans username associated with the account

​
Query Parameters

​
of_id
number
required
The OnlyFans user ID for which to retrieve PPV statistics

​
Response

​
status
string
Status of the request (success or error)
​
data
array
Array of PPV statistic objects
​
data[].id
string
Unique identifier for the PPV statistic entry
​
data[].timestamp
string
ISO timestamp of when the PPV message was sent
​
data[].price
number
Price of the PPV message in USD
​
data[].buyerCount
number
Number of subscribers who purchased the PPV message
​
data[].openRate
number
Percentage of recipients who opened the message
​
data[].conversionRate
number
Percentage of recipients who purchased the content
​
data[].revenue
number
Total revenue generated from the PPV message
​
data[].messageType
string
Type of content in the PPV message (photo, video, text, etc.)
​
data[].recipientCount
number
Total number of recipients for the PPV message

​
200 Success

{
  "status": "success",
  "data": [
    {
      "id": "ppv_92b3c1d4-5678-9012-ijkl-456789abcdef",
      "timestamp": "2023-03-10T18:30:00Z",
      "price": 4.99,
      "buyerCount": 42,
      "openRate": 76.5,
      "conversionRate": 12.4,
      "revenue": 209.58,
      "messageType": "video",
      "recipientCount": 340
    },
    {
      "id": "ppv_a1b2c3d4-5678-9012-ijkl-456789abcdef",
      "timestamp": "2023-03-05T14:15:00Z",
      "price": 2.99,
      "buyerCount": 63,
      "openRate": 82.1,
      "conversionRate": 19.2,
      "revenue": 188.37,
      "messageType": "photo",
      "recipientCount": 328
    }
  ]
}

​
400 Bad Request

{
  "status": "error",
  "error": {
    "code": "invalid_parameter",
    "message": "Parameter 'of_id' is required"
  }
}

​
401 Unauthorized

{
  "status": "error",
  "error": {
    "code": "authentication_required",
    "message": "Authentication is required to access this resource"
  }
}

​
403 Forbidden

{
  "status": "error",
  "error": {
    "code": "permission_denied",
    "message": "Your token does not have permission to access this resource"
  }
}

​
404 Not Found

{
  "status": "error",
  "error": {
    "code": "resource_not_found",
    "message": "No PPV statistics found for the specified OnlyFans ID"
  }
}

​
Error Codes

Error CodeDescription
invalid_parameterA required parameter is missing or invalid
authentication_requiredNo valid authentication token provided
permission_deniedToken lacks required permissions
resource_not_foundNo statistics found for the specified ID
service_unavailableThe statistics service is temporarily unavailable

​
Notes

  1. This endpoint provides analytics about the performance of PPV messages
  2. Statistics are updated daily
  3. The data helps creators optimize their PPV pricing and content strategy
  4. Historical data is available for the past 12 months
  5. The extension uses this data to generate time-based graphs in the PPV analytics panel

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token for authentication (JWT)

​
username
string
required

OnlyFans username associated with the account

Query Parameters

​
of_id
string
required

The OnlyFans user ID for which to retrieve PPV statistics

Response

PPV statistics retrieved successfully

​
status
string
Example:

"success"

​
data
object[]