/company/{id}/reports/{reportType}

Returns one of Breezy's reports with the same numbers the Reports page shows, for the whole company or one position. Company-wide reports need a company admin; one position's report needs report access on that position. Each user can run 10 reports a minute on top of the general API limit (more returns 429). The same report for the same user and filters is served from a cache for up to 15 minutes, so today's numbers can be up to 15 minutes old.

Fields by report (dates are YYYY-MM-DD or ISO 8601, durations are in days, percents are 0 to 100, and a value Breezy could not compute is null):

  • overview-v3: totals and previous_period (applied, sourced, referred, recruited, hired, disqualified, interviewed, views), by_day (one entry per day in the range with the same counts and a date), sources (source, applied, views, most applicants first) and stages (stage, candidates; filled only for one position).
  • pipeline-performance-v3: pipelines, each with pipeline_id, name, positions, totals (added, moved, disqualified, stalled), stages (stage names in pipeline order), movement (from_stage, to_stage, candidates, percent, avg_days_in_from_stage), stalled_by_stage, disqualified_from_stage and added_by (origin, candidates, percent).
  • time-to-fill-v3: all-time, so date_range does not change it, and only positions with a hire. days_to_fill is calendar days from the position's first publish (first_published_date, or created_date when it was never published) to its first hire (filled_date); avg_days_to_hire is the average calendar days from each hired candidate's application to their hire. avg_days_to_fill, avg_days_to_hire, by_category and positions (position_id, name, location, category, requisition_id, created_by, created_date, first_published_date, filled_date, days_to_fill, avg_days_to_hire; most recently filled first), with total_positions and truncated.
  • hired: hires (position_id, position_name, candidate_id, candidate_name, source, hired_date, hired_by; most recent first), with total and truncated.

Lists return at most 500 rows; truncated is true when there were more.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
enum
required

The report, as named on the Reports page.

Allowed:
Query Params
string

One position's report; leave it out for the whole company.

string
enum

The period the report covers (default last30Days). time-to-fill-v3 always covers all time.

date

First day of a customRange, YYYY-MM-DD.

date

Last day of a customRange, YYYY-MM-DD.

string

The pipeline pipeline-performance-v3 reports on (default the default pipeline).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json