API Reference
Usage & Analytics
Monitor application usage, success rates, and credit consumption. Includes dashboard-ready analytics and aggregated statistics.
Get Total Usage
Returns overall usage statistics for your account including total applications, success rates, and credit consumption. Optionally filter by date range.
/usage| Name | Type | Required | Description |
|---|---|---|---|
startDate | string | Optional | Filter from date (YYYY-MM-DD) |
endDate | string | Optional | Filter to date (YYYY-MM-DD) |
curl "https://apply-api.boringproject.ai/api/v1/usage?startDate=2024-02-01&endDate=2024-02-29" \
-H "Authorization: Bearer bp_live_..."{
"client_id": "client_xyz789",
"period": { "start_date": "2024-02-01", "end_date": "2024-02-29" },
"total_applications": 1500,
"successful": 1247,
"failed": 253,
"success_rate": 0.831,
"credits_used": 1247,
"credits_remaining": 8753
}Get User Usage
Returns application usage statistics for a specific user, including lifetime and monthly counts, success/failure breakdown, and remaining quota against configured limits.
/users/:userId/usagecurl https://apply-api.boringproject.ai/api/v1/users/usr_abc123/usage \
-H "Authorization: Bearer bp_live_..."{
"userId": "usr_abc123",
"totalApplications": 450,
"successful": 380,
"failed": 70,
"monthlyApplications": 45,
"monthlySuccessful": 38,
"monthlyFailed": 7,
"limits": { "maxTotalJobApplications": 1000, "maxJobApplicationsPerMonth": 100 }
}Analytics Summary
Returns a dashboard-ready analytics summary including application overview, credit usage, top users by volume, and daily application trends over the selected period.
/analytics/summary| Name | Type | Required | Description |
|---|---|---|---|
period | string | Optional | Time period: 7d, 30d, 90d, or all (default: 30d) |
curl "https://apply-api.boringproject.ai/api/v1/analytics/summary?period=30d" \
-H "Authorization: Bearer bp_live_..."{
"period": { "range": "30d", "startDate": "2024-01-15T00:00:00Z", "endDate": "2024-02-14T23:59:59Z" },
"overview": { "totalApplications": 1500, "successfulApplications": 1247, "successRate": 0.831, "averageApplicationsPerDay": 50 },
"credits": { "used": 1247, "remaining": 8753, "limit": 10000, "percentUsed": 12.47 },
"topUsers": [{ "userId": "usr_abc123", "applications": 450, "successRate": 0.844 }],
"trends": { "daily": [{ "date": "2024-02-14", "applications": 75, "successful": 63, "successRate": 0.84 }] }
}Dashboard Statistics
Returns high-level counts across all resource types for your account — users, profiles, sessions, applications, searches, and credit balance.
/statscurl https://apply-api.boringproject.ai/api/v1/stats \
-H "Authorization: Bearer bp_live_..."{
"totalUsers": 150,
"activeUsers": 120,
"totalProfiles": 185,
"totalSessions": 430,
"activeSessions": 45,
"totalApplications": 8500,
"successfulApplications": 7225,
"failedApplications": 1275,
"queuedApplications": 32,
"totalSearches": 620,
"creditBalance": 4500
}Related docs
Continue reading
Users
Create, retrieve, update, and delete users who apply for jobs through your platform.
Sessions
Create and manage job application sessions — apply to specific jobs, run one-time searches, or set up recurring autopilot campaigns.
Configuration
Manage account-level settings. Configure which candidate profile fields are mandatory before applications can be submitted.