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

# V3 identity suggestions

> The agent or visitor ids of the session cohort (the same window and page-wide filters as session-facts) that start with the query, the twenty with the most sessions first. kind defaults to viewer ids for the website scope and visitors mode, agent ids otherwise.



## OpenAPI

````yaml https://api.zeroclick.io/openapi.json get /v1/analytics/sellers/{sellerId}/session-identities
openapi: 3.0.0
info:
  title: ZeroClick API
  description: >-
    REST API for managing ZeroClick sellers, services, pricing, usage, and
    analytics. Authenticate with an API key from the ZeroClick dashboard.
  version: 1.0.0
servers:
  - url: https://api.zeroclick.io
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Sellers
  - name: Services
  - name: Meters
  - name: Plans
  - name: Plan meter prices
  - name: Usage
  - name: Analytics
  - name: Agentify
  - name: Stripe Connect
  - name: Sandbox
  - name: Organizations
  - name: Users
paths:
  /v1/analytics/sellers/{sellerId}/session-identities:
    get:
      tags:
        - Analytics
      summary: V3 identity suggestions
      description: >-
        The agent or visitor ids of the session cohort (the same window and
        page-wide filters as session-facts) that start with the query, the
        twenty with the most sessions first. kind defaults to viewer ids for the
        website scope and visitors mode, agent ids otherwise.
      parameters:
        - schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          in: query
          name: startDate
          required: true
        - schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          in: query
          name: endDate
          required: true
        - schema:
            type: string
            minLength: 1
            maxLength: 80
          in: query
          name: asOf
          required: false
        - schema:
            default: storefront
            type: string
            enum:
              - storefront
              - website
          in: query
          name: scope
          required: false
        - schema:
            default: sessions
            type: string
            enum:
              - sessions
              - visitors
          in: query
          name: counting
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: hideBots
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: hideInternal
          required: false
        - schema:
            type: string
          in: query
          name: agentTypes
          required: false
        - schema:
            anyOf:
              - type: string
                enum:
                  - unknown
              - type: string
                pattern: ^[A-Z]{2}$
          in: query
          name: country
          required: false
        - schema:
            type: string
            enum:
              - converted_paid
              - converted_trial
              - bought_unused
              - handed_off
              - quoted
              - browsed
              - left
              - reached
              - shown_link
          in: query
          name: outcome
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 1024
          in: query
          name: entry
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: entryMissing
          required: false
        - schema:
            type: string
            enum:
              - website_markdown
              - website_static
              - other_tagged
              - untagged
              - website
          in: query
          name: placement
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 256
          in: query
          name: query
          required: false
        - schema:
            type: string
            enum:
              - viewer
              - agent
          in: query
          name: kind
          required: false
        - schema:
            type: string
            minLength: 1
          in: path
          name: sellerId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  identities:
                    type: object
                    properties:
                      asOf:
                        type: string
                      kind:
                        type: string
                        enum:
                          - viewer
                          - agent
                      query:
                        nullable: true
                        type: string
                      rows:
                        type: array
                        items:
                          type: object
                          properties:
                            identity:
                              type: string
                            sessions:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                          required:
                            - identity
                            - sessions
                          additionalProperties: false
                    required:
                      - asOf
                      - kind
                      - query
                      - rows
                    additionalProperties: false
                required:
                  - identities
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in the ZeroClick dashboard under Settings → API keys.
        Keys start with `zc_`. Send them as `Authorization: Bearer zc_...`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.