Skip to main content
Manage Market Topics programmatically using the 1eye API. Create, retrieve, update, and delete Topics to define the subjects and technologies your ideal customers are researching. Topics are part of the 1eye Knowledge Base. They provide context for identifying and evaluating Market Signals, helping 1eye understand which research activities are relevant to your business. Changes made through the API are reflected in the 1eye Console, and vice versa.

Base URL

All Topic API requests use:

Authentication

All endpoints require a valid 1eye API key.
API keys are scoped to a single workspace. All operations automatically apply to the workspace associated with your API key. You do not need to provide a workspace ID. The examples below use $API_KEY as the environment variable containing your API key. For more information, see Authentication.

Endpoints

All endpoints return JSON responses, except DELETE, which returns no response body.

Topic Object

A Topic represents a subject, technology, or business challenge relevant to your ideal customers. For example, Snowbricks, a fictional cloud data and AI platform, might track interest in lakehouse architecture, cloud data warehousing, data engineering, and machine learning infrastructure.

Fields

Example Topic

System-Managed Fields

1eye automatically generates and maintains additional fields. These fields are read-only and cannot be modified through Create or Update requests.

1. List Topics

GET /v1/kb/topics Retrieve a paginated list of Topics configured in your workspace.

Query Parameters

Example Request

Example Response

200 OK

Pagination

When additional results are available, pagination.next_cursor contains a continuation token.
When next_cursor is null, there are no additional results. See Pagination.

Behavior

  • Returns Topics belonging to the authenticated workspace.
  • Excludes deleted Topics.
  • Supports cursor-based pagination.
  • Returns an empty data array when no Topics exist.

2. Retrieve a Topic

GET /v1/kb/topics/{id} Retrieve a specific Topic using its unique identifier.

Path Parameters

Example Request

Example Response

200 OK

Behavior

  • Returns the complete Topic record.
  • Includes system-generated metadata.
  • Returns 404 Not Found if the Topic does not exist, has been deleted, or belongs to another workspace.

3. Create a Topic

POST /v1/kb/topics Create a new Topic in your workspace. New Topics become available for future Market Signals processing.

Request Body

Example Request

Example Response

201 Created

Behavior

When a Topic is created:
  1. 1eye generates a unique Topic ID.
  2. The Topic is associated with your workspace.
  3. The Topic appears in the Knowledge Base.
  4. The Topic becomes available for future Market Signals processing.
  5. The Topic can be retrieved or updated through the API.
Important: Creating a Topic does not automatically generate historical Market Signals or trigger new Buyer evaluations.

Validation

  • name must not be empty.
  • short_name must not be empty.
  • description must not be empty.
  • short_name must be unique among active Topics in the workspace.
  • System-managed fields cannot be supplied.

4. Update a Topic

PATCH /v1/kb/topics/{id} Update an existing Topic. The API supports partial updates.

Request Body

At least one editable field must be supplied.

Example Request

Example Response

200 OK

Behavior

  • Updates only supplied fields.
  • Preserves omitted fields.
  • Preserves the original Topic ID.
  • Reflects changes in the Console.
  • Applies the updated Topic definition to future Market Signals processing.
Important: Updating a Topic does not automatically reprocess historical Signals or reevaluate existing Buyers.

5. Delete a Topic

DELETE /v1/kb/topics/{id} Delete a Topic from your workspace. Deletion performs a soft delete.

Example Request

Response

204 No Content The response body is empty.

What Happens When a Topic Is Deleted?

  • The Topic is removed from the active Knowledge Base.
  • It no longer appears in List Topics.
  • Retrieving the deleted Topic returns 404 Not Found.
  • The Topic is excluded from future Market Signals processing.
  • Historical Signals associated with the Topic remain preserved.
Deleting a Topic does not delete Buyers, existing Signals, or historical market activity. Restoring deleted Topics is not currently exposed through the public API.

6. How Topics Affect Market Signals

Topics help 1eye understand which areas of market research are relevant to your business. For example, Snowbricks might configure: Market Signals can include activities such as:
  • researched_topic
  • explored_product
  • evaluated_competitor
Topics primarily provide context for topic-related Market Signals. Products and Competitors are configured separately in the Knowledge Base.

Knowledge Base Integration

Historical Data

Creating, updating, or deleting Topics does not automatically trigger historical signal generation or reevaluation. Existing records remain preserved.

Console Synchronization

Changes made through the API are reflected in the 1eye Console, and vice versa.

7. Error Handling

All Topic endpoints use the standard 1eye API error format.

Example Error

404 Not Found
See Errors.

8. Pagination & Rate Limits

List Topics supports cursor-based pagination.
  • Default page size: 100.
  • Maximum page size: 1,000.
  • Use cursor for subsequent pages.
  • next_cursor: null indicates no additional results.
Topic API requests count toward your workspace API rate limits. See Pagination and Rate Limits.

9. Best Practices

Use Specific Topics

Choose topics that describe meaningful areas of customer interest. Avoid overly broad categories such as “Technology” or “Software.”

Use Consistent Short Names

Provide Business Context

Descriptions should explain the subject and why companies researching it may be relevant to your business.

Avoid Unnecessary Overlap

Use distinct Topics that represent different areas of interest. For example, Lakehouse Architecture and Data Governance are related but represent different evaluation needs.

Keep Topics Current

Update Topics as new technologies, business needs, and market terminology emerge.