---
title: "Preview Search Signal"
method: POST
path: "/search/signals/preview"
tags: ["Search"]
---

# Preview Search Signal

`POST /search/signals/preview`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/search/signals/preview`
- Auth: HTTP bearer

How many companies one signal matches on its own, before any other filter.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- SearchSignalFilter: One signal. Which list must be non-empty depends on `type`.
  - `type` 'hiring' | 'tech' | 'company_type' | 'describes' | 'lookalike' | 'new_in_role', required
  - `negate` boolean: Match companies WITHOUT the signal (hiring, tech, company_type).
  - `roles` string[]: hiring: role titles.
  - `days` integer: hiring / new_in_role: look-back window.
  - `status` 'new' | 'open'
  - `min_roles` integer
  - `exclude_staffing` boolean
  - `techs` string[]: tech: technologies.
  - `match` 'any' | 'all'
  - `categories` string[]: company_type: category ids.
  - `text` string: describes: what the companies do.
  - `facet` 'what' | 'sells' | 'serves'
  - `domains` string[]: lookalike: seed company domains.
  - `top_k` integer

## Response `200`

Successful Response

- ApiResponseWorkspaceSearchPayload
  - `data` WorkspaceSearchPayload, required: Search results, grouped the way the app groups them.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)