Skip to main content
Manage Target Pages programmatically using the 1eye API. Create, retrieve, update, and delete Target Pages to identify the website pages that matter most to your business. Target Pages are part of the 1eye Knowledge Base. They help 1eye understand which website visits indicate meaningful buying interest, such as visits to pricing, product, or demo pages. Changes made through the API are reflected in the 1eye Console, and vice versa.

Base URL

All Target Page 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.

Target Page Object

A Target Page identifies a webpage that represents meaningful visitor interest. For example, Snowbricks, a fictional cloud data and AI platform, might track visits to its pricing page because visitors reviewing pricing are often evaluating data infrastructure solutions.

Fields

Example Target Page

System-Managed Fields

1eye automatically generates and maintains additional fields. These fields are read-only.

1. List Target Pages

GET /v1/kb/target-pages Retrieve a paginated list of Target Pages 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 Target Pages belonging to the authenticated workspace.
  • Excludes deleted Target Pages.
  • Supports cursor-based pagination.
  • Returns an empty data array when no records exist.

2. Retrieve a Target Page

GET /v1/kb/target-pages/{id} Retrieve a Target Page using its unique identifier.

Path Parameters

Example Request

Example Response

200 OK

Behavior

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

3. Create a Target Page

POST /v1/kb/target-pages Create a new Target Page in your workspace.

Request Body

Example Request

Example Response

201 Created

Behavior

When a Target Page is created:
  1. 1eye generates a unique identifier.
  2. The Target Page is associated with your workspace.
  3. It appears in the Knowledge Base.
  4. It becomes available to the Website Signals processing pipeline.
  5. It can be retrieved or updated through the API.
Important: Creating a Target Page does not generate historical Website Signals or retroactively process previous visits.

Validation

  • All four fields must contain valid values.
  • short_name must be unique among active Target Pages in the workspace.
  • url must identify a valid website location.
  • System-managed fields cannot be supplied in the request.

4. Update a Target Page

PATCH /v1/kb/target-pages/{id} Update an existing Target Page. The API supports partial updates. Only supplied fields are modified.

Request Body

At least one editable field must be supplied.

Example Request

Example Response

200 OK

Behavior

  • Updates only supplied fields.
  • Preserves the original resource identifier.
  • Reflects changes in the Console.
  • Applies the updated configuration to future Website Signals processing.
  • Does not automatically reprocess historical visits.

5. Delete a Target Page

DELETE /v1/kb/target-pages/{id} Delete a Target Page from your workspace. Deletion performs a soft delete, preserving historical data.

Example Request

Response

204 No Content The response body is empty.

What Happens When a Target Page Is Deleted?

  • The Target Page disappears from the active Knowledge Base.
  • It is excluded from future Target Page matching.
  • It no longer appears in List Target Pages.
  • Retrieving the deleted record returns 404 Not Found.
  • Historical Website Signals remain preserved.
Deleting a Target Page does not delete Buyers, historical visits, or previously generated Signals. Website visits may continue to be collected by the installed 1eye pixel. Deleting a Target Page only removes its active targeting configuration. Restoring deleted Target Pages is not currently exposed through the public API.

6. URL Matching & Normalization

1eye uses canonical URL matching to identify configured Target Pages. Customers provide the page URL. 1eye handles normalization internally.

URL Normalization

1eye normalizes URLs to avoid differences caused by:
  • http versus https.
  • Hostname capitalization.
  • Unnecessary trailing slashes.
  • URL fragments.
  • Tracking parameters such as utm_source, utm_medium, gclid, and fbclid.
Meaningful path segments and query parameters that identify distinct pages are preserved.

Example

The following URLs should resolve to the same Target Page:

Exact Canonical Matching

Target Pages use exact matching against the normalized canonical URL. There is no configurable match_type field. There is also no need to supply a separate domain field. The domain is derived from the URL.

Target Page vs. Target Form

A Target Page represents a page visit. A Target Form represents a form submission. Visiting a page containing a form does not, by itself, mean the visitor submitted that form.

7. Error Handling

All Target Page endpoints use the standard 1eye API error format.

Example Error

404 Not Found
For more information, see Errors.

8. Pagination & Rate Limits

List Target Pages uses the existing cursor-based pagination system.
  • Default page size: 100.
  • Maximum page size: 1,000.
  • Use cursor for subsequent pages.
  • next_cursor: null indicates no additional results.
Target Page requests count toward your workspace API rate limits. Rate limits are shared across API keys within the same workspace. See Pagination and Rate Limits.

9. How Target Pages Affect Website Signals

Target Pages help 1eye identify website activity associated with meaningful buying interest. For example, Snowbricks might configure:

Knowledge Base Integration

Console Synchronization

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

10. Best Practices

Track High-Intent Pages

Prioritize pages that indicate meaningful buying interest, such as pricing, product, integrations, and demo pages.

Use Descriptive Names

Choose names that identify the purpose of the page. Examples:

Use Consistent Short Names

Write Meaningful Descriptions

Explain what the page represents and why visiting it matters. A description should provide useful business context rather than simply repeat the page title.

Use Canonical URLs

Provide the primary page URL without unnecessary campaign or tracking parameters. 1eye handles canonical normalization automatically.

Delete Carefully

Deleting a Target Page removes its active targeting configuration. Historical Signals remain available.