> ## Documentation Index
> Fetch the complete documentation index at: https://developers.explorium.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Keyword search on websites

## Description

The **Keyword Search on Websites Enrichment** endpoint enables users to **identify keyword occurrences on a company's website**. This dataset is valuable for **market researchers, competitive analysts, and SEO strategists** looking to **analyze content relevance and online presence**.

The data includes:

* **Keyword presence detection**, confirming whether a term appears on a site.
* **Snippet extraction**, showcasing relevant text segments containing the keyword.
* **Direct URLs to content**, allowing for further review and validation.

This information is sourced from **real-time website crawls and indexed public web pages** to provide **comprehensive insights into company messaging and search visibility**.

<AccordionGroup>
  <Accordion title="How It Works">
    * **Input:** Provide a `business_id` obtained from the **Match Businesses** API.
    * **Processing:** The system scans the target website and retrieves keyword matches.
    * **Output:** A structured response highlighting keyword occurrences, extracted snippets, and URLs.
  </Accordion>

  <Accordion title="Best Practices">
    * **Use keyword insights** to track industry-specific terminology and brand messaging.
    * **Analyze keyword frequency** to gauge content focus and relevance.
    * **Leverage snippet extractions** for competitor research and content benchmarking.
    * **Monitor website content** to ensure alignment with marketing and SEO strategies.
  </Accordion>

  <Accordion title="Keyword Search on Websites Output Signal">
    | SignalAPI           | Name                  | Description                                                                                                                                                                                                                                                                    | Data Type |
    | :------------------ | :-------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------- |
    | text\_results       | Keyword search result | JSON-formatted list of search results, indicating the location of the queried keywords within the snippet. Each result includes a snippet of text containing the keywords, the corresponding URL, and a numeric ranking of where the keyword is positioned within the snippet. | array     |
    | keywords\_indicator | URL has keyword       | True if the URL contains the queried keywords.                                                                                                                                                                                                                                 | string    |
    | url                 | URL                   | Website associated with Explorium's entity ID queried for the input keywords.                                                                                                                                                                                                  | url       |
  </Accordion>
</AccordionGroup>

<Icon icon="thumbtack" iconType="solid" color="red" /> For additional enrichment options, explore related API endpoints below.

## Body Params - Try Me Example

```
business_id: 8adce3ca1cef0c986b22310e369a0793
keywords: iphone, data
```


## OpenAPI

````yaml post /v1/businesses/company_website_keywords/enrich
openapi: 3.1.0
info:
  title: Partner Service
  version: 0.2.349
servers:
  - url: https://api.explorium.ai
    description: AgentSource Server
security: []
paths:
  /v1/businesses/company_website_keywords/enrich:
    post:
      tags:
        - BusinessEnrichments
      summary: Company Website Keywords
      operationId: businesses_company_website_keywords_enrich
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyWebsiteKeywordsEnrichRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BusinessesEnrichResponse_CompanyWebsiteKeywordsOutputSchema_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - APIKeyHeader: []
components:
  schemas:
    CompanyWebsiteKeywordsEnrichRequest:
      properties:
        request_context:
          type: object
          title: Request Context
          example: null
          nullable: true
        parameters:
          $ref: '#/components/schemas/CompanyWebsiteKeywordsEnrichmentParams'
        business_id:
          type: string
          pattern: ^[a-f0-9]{32}$
          title: Business Id
      additionalProperties: false
      type: object
      required:
        - parameters
        - business_id
      title: CompanyWebsiteKeywordsEnrichRequest
    BusinessesEnrichResponse_CompanyWebsiteKeywordsOutputSchema_:
      properties:
        response_context:
          $ref: '#/components/schemas/ResponseContext'
        data:
          anyOf:
            - $ref: '#/components/schemas/CompanyWebsiteKeywordsOutputSchema'
            - items:
                $ref: '#/components/schemas/CompanyWebsiteKeywordsOutputSchema'
              type: array
          title: Data
        entity_id:
          anyOf:
            - type: string
              pattern: ^[a-f0-9]{32}$
            - type: string
              pattern: ^[a-f0-9]{40}$
          title: Entity Id
      type: object
      required:
        - response_context
      title: BusinessesEnrichResponse[CompanyWebsiteKeywordsOutputSchema]
      description: 'This is base response model for all responses in partner service. '
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CompanyWebsiteKeywordsEnrichmentParams:
      properties:
        keywords:
          items:
            type: string
          type: array
          title: Keywords
      additionalProperties: false
      type: object
      required:
        - keywords
      title: CompanyWebsiteKeywordsEnrichmentParams
    ResponseContext:
      properties:
        correlation_id:
          type: string
          title: Correlation Id
        request_status:
          $ref: '#/components/schemas/RequestStatus'
        time_took_in_seconds:
          type: number
          title: Time Took In Seconds
      type: object
      required:
        - correlation_id
        - request_status
        - time_took_in_seconds
      title: ResponseContext
    CompanyWebsiteKeywordsOutputSchema:
      properties:
        url:
          type: string
          maxLength: 2048
          pattern: >-
            ^(https?:)?//(?:(?:[a-z0-9\u00a1-\uffff][a-z0-9\u00a1-\uffff_-]{0,62})?[a-z0-9\u00a1-\uffff]\.)+[a-z\u00a1-\uffff]{2,}\.?(?:[/?#]\S*)?$
          format: uri
          title: Url
        keywords_indicator:
          type: string
          title: Keywords Indicator
        text_results:
          items:
            type: object
          type: array
          title: Text Results
      type: object
      title: CompanyWebsiteKeywordsOutputSchema
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    RequestStatus:
      type: string
      enum:
        - success
        - miss
        - failure
      title: RequestStatus
      description: >-
        The `RequestStatus` class is an enumeration that defines the possible
        statuses of a request.


        This enum is used to indicate whether a request was successful, missed,
        or failed. It ensures

        consistent handling of request statuses across the application.


        Attributes:
            SUCCESS: Indicates that the request was successfully processed.
            MISS: Indicates that the request did not find any matching data.
            FAILURE: Indicates that the request encountered an error or failure.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: api_key

````