> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # Search website tracked events > The custom events a site sends that the team registered by name (gs('event', name) in the site's script): one row per tracked event with its label and is_conversion. Only a registered name becomes the fact website_event and a session filter (search_website_sessions filter.event); every event is still kept on the session's events[] for the feed. site_sid.eq is the usual scope, q searches event and label. Contract: - MCP tool `search_website_tracked_events`, registry package `mcp.signals/website_tracked_events`, mount `signals.website`. - Operation `search`, response envelope `search`. - Flags: read only. ## OpenAPI ````yaml /api-reference/signals/openapi.yaml post /api/website-tracked-events/search openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.signals' description: >- The signals service, its website lane: the team's registered sites with their key pages and tracked events, the team switch for the codes in links, and what the tracking plane saw: every visit as a session with its pages, forms and network, the browsers behind them and the people they were bound to; and, since P0 of its LinkedIn leg, who looked at a sender profile's LinkedIn profile (the sightings of the premium list, read once a day). GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.signals`, 30 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/signals/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: profile_view_sightings description: >- Registry package `mcp.signals/profile_view_sightings`, served on MCP mount `signals.visits`. - name: signal_preferences description: >- Registry package `mcp.signals/signal_preferences`, served on MCP mount `signals.website`. - name: signal_settings description: >- Registry package `mcp.signals/signal_settings`, served on MCP mount `signals.website`. - name: website_key_pages description: >- Registry package `mcp.signals/website_key_pages`, served on MCP mount `signals.website`. - name: website_session_owners description: >- Registry package `mcp.signals/website_session_owners`, served on MCP mount `signals.visits`. - name: website_sessions description: >- Registry package `mcp.signals/website_sessions`, served on MCP mount `signals.visits`. - name: website_sites description: >- Registry package `mcp.signals/website_sites`, served on MCP mount `signals.website`. - name: website_tracked_events description: >- Registry package `mcp.signals/website_tracked_events`, served on MCP mount `signals.website`. - name: website_visitors description: >- Registry package `mcp.signals/website_visitors`, served on MCP mount `signals.visits`. paths: /api/website-tracked-events/search: post: tags: - website_tracked_events summary: Search website tracked events description: >- The custom events a site sends that the team registered by name (gs('event', name) in the site's script): one row per tracked event with its label and is_conversion. Only a registered name becomes the fact website_event and a session filter (search_website_sessions filter.event); every event is still kept on the session's events[] for the feed. site_sid.eq is the usual scope, q searches event and label. Contract: - MCP tool `search_website_tracked_events`, registry package `mcp.signals/website_tracked_events`, mount `signals.website`. - Operation `search`, response envelope `search`. - Flags: read only. operationId: search_website_tracked_events requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SearchWebsiteTrackedEventsRequest' responses: '200': description: '`search` success envelope.' content: application/json: schema: $ref: '#/components/schemas/SearchWebsiteTrackedEventsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: SearchWebsiteTrackedEventsRequest: type: object description: Request body of `search_website_tracked_events`. properties: filter: type: object properties: q: type: string maxLength: 128 description: Free text over event and label (a LIKE). sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^sg_te_ description: Website tracked event sid (sg_te_...). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^sg_te_ description: Website tracked event sid (sg_te_...). additionalProperties: false description: >- Tracked event sid(s), sg_te_ prefix: also the point lookup (there is no get tool). site_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^sg_si_ description: Website site sid (sg_si_...), the event's site. in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^sg_si_ description: Website site sid (sg_si_...), the event's site. additionalProperties: false description: 'The usual scope: one site''s events.' event: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: The name(s) as registered. is_conversion: type: object properties: eq: type: boolean additionalProperties: false description: The conversion events only. created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: ISO 8601 range; combine bounds in one object. deleted_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: >- Default scope is { is_null: true } (live rows); stating it at all lifts the soft-delete scope. description: >- Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt | lt | is_null}}; q inside it is free text. Omit for every row. sort: type: object properties: field: type: string enum: - created_at - event description: The column to order by. direction: type: string enum: - asc - desc description: asc or desc; default desc. required: - field description: One column and its direction; omit for the default order. page_size: type: integer minimum: 0 maximum: 500 description: 0..500, default 50; 0 = counts only, 1 = the first row. cursor: type: string nullable: true description: pagination.next_cursor of the previous page. SearchWebsiteTrackedEventsResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - search items: type: array items: type: object properties: item: type: object properties: sid: type: string description: Website tracked event sid (sg_te_...). team_sid: type: string description: 'Owning team (ts_tm_..., external: gs.service.id).' site_sid: type: string description: The site the event belongs to (sg_si_...). event: type: string description: >- The name the site sends, stored as entered, matched without letter case; immutable (a fact's key carries it). label: type: string description: What the event is called in the feed. is_conversion: type: boolean description: Counted as a conversion in the feed and the Overview card. created_by: type: object properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: >- The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: >- Internal audit context: the cluster that served the write. trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions description: Actor that registered the event. created_at: type: string description: ISO 8601 UTC. updated_at: type: string description: ISO 8601 UTC. deleted_at: type: string nullable: true description: >- ISO 8601 UTC; null = live. Also set by the site's cleanup job. required: - sid - team_sid - site_sid - event - label - is_conversion - created_by - created_at - updated_at - deleted_at included: type: object additionalProperties: {} required: - item - included pagination: type: object properties: next_cursor: type: string nullable: true has_more: type: boolean total_count: type: integer nullable: true required: - next_cursor - has_more - total_count applied_filters: type: object additionalProperties: {} includes: type: array items: type: string meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms counts: type: object additionalProperties: {} required: - success - operation - items - pagination - applied_filters - includes - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- Access token issued by gs.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.