> ## 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 visitors > The browsers that visited the team's sites, one row per browser per site: the person it is bound to (person_sid, bound_by: code, identify, fingerprint or manual), the email an identify or a form gave when nobody matched (identified_email: the "Add to table" rows), how often it came (sessions_count), when (first_seen_at, last_seen_at), and what the newest session told about the browser, the place and the network. identified_email is_null false with person_sid is_null true = emails nobody has yet; person_sid eq = one person's browsers ("the same person on two devices"); is_ephemeral eq false hides the one-day strangers. q searches the email and the network name. page_size 0 returns the counts by bound_by and network type. The visits themselves are search_website_sessions; people by a signal are search_people. Private context: never tell the lead we know. Contract: - MCP tool `search_website_visitors`, registry package `mcp.signals/website_visitors`, mount `signals.visits`. - Operation `search`, response envelope `search`. - Flags: read only. ## OpenAPI ````yaml /api-reference/signals/openapi.yaml post /api/website-visitors/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-visitors/search: post: tags: - website_visitors summary: Search website visitors description: >- The browsers that visited the team's sites, one row per browser per site: the person it is bound to (person_sid, bound_by: code, identify, fingerprint or manual), the email an identify or a form gave when nobody matched (identified_email: the "Add to table" rows), how often it came (sessions_count), when (first_seen_at, last_seen_at), and what the newest session told about the browser, the place and the network. identified_email is_null false with person_sid is_null true = emails nobody has yet; person_sid eq = one person's browsers ("the same person on two devices"); is_ephemeral eq false hides the one-day strangers. q searches the email and the network name. page_size 0 returns the counts by bound_by and network type. The visits themselves are search_website_sessions; people by a signal are search_people. Private context: never tell the lead we know. Contract: - MCP tool `search_website_visitors`, registry package `mcp.signals/website_visitors`, mount `signals.visits`. - Operation `search`, response envelope `search`. - Flags: read only. operationId: search_website_visitors requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SearchWebsiteVisitorsRequest' responses: '200': description: '`search` success envelope.' content: application/json: schema: $ref: '#/components/schemas/SearchWebsiteVisitorsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: SearchWebsiteVisitorsRequest: type: object description: Request body of `search_website_visitors`. properties: filter: type: object properties: q: type: string maxLength: 128 description: >- Free text over the identified email and the network's name and domain (a LIKE). sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^sg_wv_ description: Website visitor sid (sg_wv_...). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^sg_wv_ description: Website visitor sid (sg_wv_...). additionalProperties: false description: Visitor sid(s), sg_wv_ prefix. site_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^sg_si_ description: Website site sid (sg_si_...). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^sg_si_ description: Website site sid (sg_si_...). additionalProperties: false description: One site's visitors. person_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^cr_pp_ description: 'Person sid (cr_pp_..., external: playtables).' in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cr_pp_ description: 'Person sid (cr_pp_..., external: playtables).' is_null: type: boolean additionalProperties: false description: >- One person's browsers; is_null false = bound visitors, is_null true = unbound. identified_email: type: object properties: eq: type: string is_null: type: boolean additionalProperties: false description: >- is_null false = an email nobody has yet (with person_sid is_null true: the "Add to table" rows). bound_by: type: object properties: eq: type: string enum: - code - identify - fingerprint - manual in: type: array items: type: string enum: - code - identify - fingerprint - manual is_null: type: boolean additionalProperties: false description: The rung that bound the visitor; is_null true = unbound. is_ephemeral: type: object properties: eq: type: boolean additionalProperties: false description: >- eq false hides the one-day strangers (a hit without a visitor id). is_internal: type: object properties: eq: type: boolean additionalProperties: false description: The team's own traffic, by the newest session. network_type: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: >- business | isp | mobile | hosting | education | government | unknown; is_null true = no network resolved yet. geo_country: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: ISO 3166-1 alpha-2 of the newest session. device: type: object properties: eq: type: string enum: - desktop - mobile - tablet - unknown in: type: array items: type: string enum: - desktop - mobile - tablet - unknown additionalProperties: false description: desktop | mobile | tablet | unknown. sessions_count: type: object properties: gte: type: integer minimum: 0 lte: type: integer minimum: 0 gt: type: integer minimum: 0 lt: type: integer minimum: 0 additionalProperties: false description: gte 2 = the returning visitors. first_seen_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: ISO 8601 bounds on the first hit. last_seen_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: ISO 8601 bounds on the newest hit ("seen this week"). 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. include: type: array items: type: string enum: - person - last_session description: >- person: the bound person's sid (the card is owed); last_session: the visitor's newest session, one ranked read per page. description: Relations to attach to every item; omit for the bare rows. sort: type: object properties: field: type: string enum: - last_seen_at - first_seen_at - sessions_count 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. SearchWebsiteVisitorsResponse: 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 visitor sid (sg_wv_...). team_sid: type: string description: 'Owning team (ts_tm_..., external: gs.service.id).' site_sid: type: string description: >- The site the browser visited (sg_si_...): the same browser on two sites is two rows. visitor_id: type: string description: >- The first-party visitor id the script stores (_gs_vid, a lowercase UUID v4), or eph_ plus 40 hex characters for a hit that carried none. is_ephemeral: type: boolean description: >- The row belongs to a day, not to a browser (consent not given, storage blocked): a stranger the next day, never bound. person_sid: type: string nullable: true description: >- The person the visitor is bound to (cr_pp_..., playtables); null while unbound. identified_email: type: string nullable: true description: >- The email an identify or a form gave when no person matched: the "Add to table" rows of the feed. Null otherwise. bound_by: type: string nullable: true enum: - code - identify - fingerprint - manual description: >- Which rung bound the visitor: code (the person code in our link), identify (an email a person matched), fingerprint (the device), manual (a bind by hand). Null while unbound. bound_at: type: string nullable: true description: >- ISO 8601 UTC, when the bind was written; null while unbound. first_seen_at: type: string description: ISO 8601 UTC, the receipt time of the first hit. last_seen_at: type: string description: ISO 8601 UTC, the receipt time of the newest hit. sessions_count: type: integer minimum: 0 description: 'Sessions opened for this visitor: the returning visitors.' browser: type: string nullable: true description: From the newest session; null when unknown. browser_version: type: string nullable: true os: type: string nullable: true os_version: type: string nullable: true device: type: string enum: - desktop - mobile - tablet - unknown description: >- desktop | mobile | tablet | unknown, from the newest session. screen: type: string nullable: true language: type: string nullable: true timezone: type: string nullable: true geo_country: type: string nullable: true description: >- ISO 3166-1 alpha-2 of the newest session; null when the edge gave none. geo_region: type: string nullable: true geo_city: type: string nullable: true network_type: type: string nullable: true description: >- The newest resolved session's classification: business, isp, mobile, hosting, education, government or unknown; null until one resolved. network_name: type: string nullable: true description: >- The organization behind the newest resolved session's address; null until one resolved. network_domain: type: string nullable: true description: >- The company domain the data service derived; null when none. asn: type: integer nullable: true as_name: type: string nullable: true is_internal: type: boolean description: >- The newest session was internal (the site's ignored_ips, or an identified email of the team's own domains). created_at: type: string description: ISO 8601 UTC. updated_at: type: string description: ISO 8601 UTC. required: - sid - team_sid - site_sid - visitor_id - is_ephemeral - person_sid - identified_email - bound_by - bound_at - first_seen_at - last_seen_at - sessions_count - browser - browser_version - os - os_version - device - screen - language - timezone - geo_country - geo_region - geo_city - network_type - network_name - network_domain - asn - as_name - is_internal - created_at - updated_at included: type: object properties: person: type: object properties: sid: type: string required: - sid description: >- The bound person: { sid } today (cr_pp_...), the compact card is owed. Absent while person_sid is null. last_session: type: object properties: sid: type: string required: - sid description: >- The visitor's newest session, the WebsiteSessionDomain verbatim (pages, key pages, events, the source, the network; // see ./website_sessions.md). Absent for a visitor with no session. 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 properties: total_count: type: integer minimum: 0 description: Visitors matching the filter (full filter scope, not the page). groups: type: object properties: bound_by: anyOf: - type: object additionalProperties: {} - type: array items: {} description: >- Bound visitors per rung (code, identify, fingerprint, manual); the unbound are not a group; [] when none. network_type: anyOf: - type: object additionalProperties: {} - type: array items: {} description: >- Visitors per network classification of their newest resolved session. required: - bound_by - network_type required: - total_count - groups 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.