Data Exports
List Data Exports
Get a paginated list of data exports for the team
get/api/data-exports
Query parameters
per_pageinteger
Number of results per page. Default 15, max 100
Example:15
Number of results per page. Default 15, max 100
pageinteger
Page number for pagination. Default 1
Example:1
Page number for pagination. Default 1
status'calculating_credits' | 'calculating_credits_failed' | 'calculating_credits_completed' | 'pending' | 'in_progress' | 'completed' | 'failed'
Filter by status
Example:completed
Filter by status
type'transactions' | 'chat_messages' | 'media_vault' | 'trial_links' | 'tracking_links' | 'payouts' | 'chargebacks' | 'public_profiles'
Filter by export type
Example:transactions
Filter by export type
download_url_expires_ininteger
Number of minutes until download URLs expire. Min 1, max 60, default 5.
Example:15
Number of minutes until download URLs expire. Min 1, max 60, default 5.
Response
Success
Example response
{
"data": {
"data": [
{
"id": "data_export_abc123xyz789",
"type": "transactions",
"status": "completed",
"start_date": "2024-01-01T00:00:00+00:00",
"end_date": "2024-12-31T23:59:59+00:00",
"file_type": "csv",
"total_rows": 5000,
"rows_processed": 5000,
"progress_percentage": 100,
"credit_cost": 500,
"export_columns": [
"transaction_id",
"type",
"amount",
"net_amount",
"currency",
"created_at"
],
"accounts": [
{
"id": "acct_xyz789abc123",
"display_name": "Main Account"
}
],
"created_at": "2024-12-01T10:00:00+00:00",
"completed_at": "2024-12-01T10:05:00+00:00",
"failed_at": null,
"failed_reason": null,
"download_url": "https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...",
"download_url_expires_at": "2024-12-02T12:05:00+00:00"
},
{
"id": "data_export_def456uvw012",
"type": "chat_messages",
"status": "in_progress",
"start_date": "2024-06-01T00:00:00+00:00",
"end_date": "2024-12-31T23:59:59+00:00",
"file_type": "xlsx",
"total_rows": 15000,
"rows_processed": 7500,
"progress_percentage": 50,
"credit_cost": 1500,
"export_columns": [
"chat_id",
"message_id",
"message_text",
"fan_username",
"onlyfans_created_at"
],
"accounts": [
{
"id": "acct_xyz789abc123",
"display_name": "Main Account"
},
{
"id": "acct_mno345pqr678",
"display_name": "Secondary Account"
}
],
"created_at": "2024-12-02T11:30:00+00:00",
"completed_at": null,
"failed_at": null,
"failed_reason": null
}
],
"meta": {
"current_page": 1,
"last_page": 3,
"per_page": 15,
"total": 42
}
},
"_meta": {
"_credits": {
"used": 0,
"balance": 9500,
"note": "Always"
},
"_cache": {
"is_cached": false,
"note": "Cache disabled for this endpoint"
},
"_rate_limits": {
"limit_minute": 60,
"limit_day": null,
"remaining_minute": 56,
"remaining_day": null,
"notice": ""
}
}
}