API Reference

Usage & Analytics

Track application usage, monitor success rates, and get dashboard-ready analytics for your account.

Get Total Usage

Get overall usage statistics for your client account including total applications, success rates, credit usage, and breakdowns by user and session.

GET/usage

Name	Type	Required	Description
`startDate`	`string`	Optional	Filter from date (YYYY-MM-DD)
`endDate`	`string`	Optional	Filter to date (YYYY-MM-DD)
`period`	`string`	Optional	current month or specific YYYY-MM

Response200 OK

{
  "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

Get application usage statistics for a specific user including limits, total and monthly application counts, and success/failure breakdown.

GET/users/:userId/usage

Response200 OK

{
  "userId": "usr_abc123",
  "totalApplications": 450,
  "successful": 380,
  "failed": 70,
  "monthlyApplications": 45,
  "monthlySuccessful": 38,
  "monthlyFailed": 7,
  "limits": { "maxTotalJobApplications": 1000, "maxJobApplicationsPerMonth": 100 }
}

Analytics Summary

Get a dashboard-ready analytics summary with overview stats, top users, top sessions, recent activity, and daily trends.

GET/analytics/summary

Name	Type	Required	Description
`period`	`string`	Optional	Time period: 7d, 30d, 90d, or all (default: 30d)

Response200 OK

{
  "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 }] }
}

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 client-specific settings including mandatory profile fields that determine what information is required before submitting applications.