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());
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/reporting/search
- Auth: HTTP bearer
Query parameters
Canonical V1 reporting family. Short aliases and natural language are not accepted on the HTTP route.
Required ISO date or datetime window start.
Required ISO date or datetime window end.
Exact canonical job_... role scope. Mutually exclusive with job_posting_id and role_label.
Exact canonical jp_... posting scope. Mutually exclusive with job_id and role_label.
Exact role-label fallback for legacy reporting rows without job or posting ids.
Set to false to omit dashboard/reporting links. Defaults to true.
Queue result cap for bounded reporting families.
Cursor for bounded queue families.
Comma-separated exact application status filters for queue-style families.
Comma-separated exact stage filters for queue-style families.
Exact source label filter for source-signal reporting.
Exact score band filter for candidate-pool reporting.
Minimum stale-days threshold for stale opportunity queues.
Minimum sample size threshold for reporting families that expose warning bands.
Headers
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
Changes
No recorded changes to this operation across all 1 revision of this API.