---
title: "Search reporting"
method: GET
path: "/v1/reporting/search"
tags: ["Reporting"]
---

# Search reporting

`GET /v1/reporting/search`

## Request

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

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):**

```bash
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):**

```ts
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());
```

## Query parameters

- `query_family` 'role_health_attention' | 'funnel_snapshot_by_role' | 'stale_opportunity_queue' | 'missing_feedback_queue' | 'candidate_pool_strength' | 'source_signals', required
- `window_start` string, required
- `window_end` string, required
- `job_id` string
- `job_posting_id` string
- `role_label` string
- `include_links` boolean
- `limit` integer
- `starting_after` string
- `statuses` string
- `stages` string
- `source_label` string
- `score_band` string
- `stale_days` integer
- `minimum_sample_size` integer

## Headers

- `X-Request-Id` string

## Response `200`

Success

- ReportingSearchResult: Public reporting search response envelope for canonical V1 recruiting reporting families. Results are redacted summaries and counts, not raw notes or private scorecard text.
  - `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
  - `filters` object, required: Normalized filters. Role scope is exact and uses job_id, job_posting_id, or role_label.
  - `data_gaps` string[], 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.
  - `results` unknown[], required
    - unknown
  - `links` object, required
    - `reporting_url` string, required
  - `metadata` object, required
    - `livemode` boolean, required
    - `aggregation_status` string, required
    - `result_count` integer, required
    - `truncated` boolean, required
    - `limit` integer, required
    - `next_cursor` string, nullable, required
    - `query_time_ms` integer, required
    - `source` 'v1_reporting_rpc', required
    - `truncation_reason` 'limit' | 'v1_row_cap'
  - `warnings` string[], required

## Other responses

- `400`: Invalid request
- `401`: Authentication failure
- `403`: Permission denied (scope or feature flag)
- `404`: Resource not found. The error uses the resource-specific code and param names the exact body field or path parameter that referenced it.
- `409`: Conflict (e.g. idempotency key reuse with different body)
- `429`: Rate limited
- `500`: Internal error

---

[API](https://skmtc.dev/yardstick/apis/yardstick-public-api.md) · [All operations](https://skmtc.dev/yardstick/apis/yardstick-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yardstick/apis/yardstick-public-api/revisions/35b5a6e88b35?raw)