---
title: "Keywords Create From Domain"
method: POST
path: "/intent/keywords/create-from-domain"
tags: ["Intent"]
---

# Keywords Create From Domain

`POST /intent/keywords/create-from-domain`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/intent/keywords/create-from-domain`
- Auth: HTTP bearer

One-shot compete-tracking keyword create.

Under the hood:
  1. `pages-by-domain` -> on-domain / subdomain URLs only
  2. `contacts` -> pre-resolved people across those URLs
  3. `save-from-search` -> persists the keyword row with both

The off-domain guard is strict: every page returned from step 1 is
re-checked against `^(.+\.)?<domain>$` before save, so nothing that
isn't actually on the competitor's site can slip in.

## Headers

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

## Request body

- KeywordCreateFromDomainRequest
  - `domain` string, required: Competitor domain to track, e.g. 'cognism.com'.
  - `page_limit` integer: Max pages to seed from the domain.
  - `contact_limit` integer: Max contacts to pre-resolve.
  - `dry_run` boolean: Preview only: find the on-domain pages and resolve contacts exactly as a real run would, but save nothing. The counts then say what WOULD be seeded, keyword_id stays null, and sample_pages / sample_contacts show a preview. Default false keeps the one-call create.

## Response `200`

Successful Response

- ApiResponseKeywordCreateFromDomainResponse
  - `data` KeywordCreateFromDomainResponse, required
    - `keyword_id` string, nullable
    - `keyword` string, required
    - `pages_seeded` integer
    - `contacts_seeded` integer
    - `companies_seeded` integer
    - `off_domain_rejected` integer
    - `message` string
    - `dry_run` boolean: True when nothing was saved (preview).
    - `sample_pages` IntentPageItem[]: Dry run only: up to 10 of the pages that would be seeded.
      - `url` string, nullable
      - `domain_root` string, nullable
      - `title` string, nullable
      - `summary` string, nullable
      - `commercial_score` number, nullable
      - `mention_score` number, nullable
      - `page_type` string, nullable
      - `audience` string, nullable
      - `visitors` integer, nullable: Distinct visitors (hashed emails) in the lookback window. Set only by pages/search with include_visitors=true when the count succeeded; null otherwise.
    - `sample_contacts` CreateFromDomainSampleContact[]: Dry run only: up to 10 of the contacts that would be pre-resolved (no emails).
      - `name` string, nullable
      - `job_title` string, nullable
      - `company_name` string, nullable
      - `company_domain` string, nullable
  - `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)