Reporting

Search reporting

Search reporting

Required scopes: reporting:read

Read-only bounded recruiting reporting. query_family must be one of the canonical V1 reporting families; window_start and window_end are required; mode comes from the API token and cannot be overridden by livemode. Exact job_id and job_posting_id scopes fail closed for legacy reporting families until exact scoped reporting aggregations are available; prospect_ops_summary can use exact Job or Job Posting context for deterministic Prospect CRM operations counts. role_label remains an exact legacy fallback for non-prospect families. Responses expose counts, data-gap labels, canonical display ids, and dashboard links, and never expose raw scorecard notes, interviewer notes, decision brief text, emails, source internals, ROI, diversity, predictive, retention, or post-hire metrics.

Example (curl):

curl 'https://api.yardstick.team/v1/reporting/search?query_family=role_health_attention&window_start=2026-05-01&window_end=2026-05-26&role_label=AI%20Content%20Manager' \
  -H 'Authorization: Bearer ys_sk_live_…'

Example (TypeScript):

await fetch(
  "https://api.yardstick.team/v1/reporting/search?query_family=role_health_attention&window_start=2026-05-01&window_end=2026-05-26&role_label=AI%20Content%20Manager",
  { headers: { Authorization: `Bearer ${process.env.YS_API_KEY}` } },
).then((r) => r.json());
get/v1/reporting/search

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/reporting/search
  • Auth: HTTP bearer

Query parameters

query_family'role_health_attention' | 'funnel_snapshot_by_role' | 'stale_opportunity_queue' | 'missing_feedback_queue' | 'candidate_pool_strength' | 'source_signals' required

Canonical V1 reporting family. Short aliases and natural language are not accepted on the HTTP route.

window_startstring required

Required ISO date or datetime window start.

window_endstring required

Required ISO date or datetime window end.

job_idstring

Exact canonical job_... role scope. Mutually exclusive with job_posting_id and role_label.

job_posting_idstring

Exact canonical jp_... posting scope. Mutually exclusive with job_id and role_label.

role_labelstring

Exact role-label fallback for legacy reporting rows without job or posting ids.

include_linksboolean

Set to false to omit dashboard/reporting links. Defaults to true.

limitinteger

Queue result cap for bounded reporting families.

starting_afterstring

Cursor for bounded queue families.

statusesstring

Comma-separated exact application status filters for queue-style families.

stagesstring

Comma-separated exact stage filters for queue-style families.

source_labelstring

Exact source label filter for source-signal reporting.

score_bandstring

Exact score band filter for candidate-pool reporting.

stale_daysinteger

Minimum stale-days threshold for stale opportunity queues.

minimum_sample_sizeinteger

Minimum sample size threshold for reporting families that expose warning bands.

Headers

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Response

Success

object'reporting_search_result' required
query_family'role_health_attention' | 'funnel_snapshot_by_role' | 'stale_opportunity_queue' | 'missing_feedback_queue' | 'candidate_pool_strength' | 'source_signals' | 'prospect_ops_summary' required
filtersobject required

Normalized filters. Role scope is exact and uses job_id, job_posting_id, or role_label.

data_gapsstring[] required

V1 reporting data-gap labels such as zero, unknown, not_tracked_yet, sample_size_warning, no_selected_role, no_data_in_date_window, or pre_instrumentation_history.

warningsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.