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

# Listar cliques do link

> Lista cada clique registrado em um link curto.



## OpenAPI

````yaml /short-links-api/api-reference/openapi-short-links.json get /v1/short-links/{id}/clicks
openapi: 3.0.3
info:
  title: Notifique API. Links curtos (Short Links)
  description: >-
    API para **criar**, **listar**, **atualizar** e **remover** links curtos do
    workspace (domínio padrão **clicar.co** ou o configurado), além de
    **analytics** (série temporal e quebras) e **lista de cliques** individuais.


    **Autenticação:** API Key em `Authorization: Bearer sk_live_xxxxx` ou
    `x-api-key: sk_live_xxxxx`. O **workspace** é sempre o da chave (cada API
    Key pertence a um workspace); **não** envie `x-workspace-id` na API v1,
    requisições com esse cabeçalho preenchido recebem **400**
    (`WORKSPACE_HEADER_NOT_ALLOWED`).


    **Escopos:** `short_links:read` (GET) e `short_links:manage` (POST, PATCH,
    DELETE).
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfShortLinksBearerAuth: []
  - ntfShortLinksApiKeyHeader: []
tags:
  - name: Short links
    description: CRUD, listagem, analytics e eventos de clique em `/v1/short-links`.
paths:
  /v1/short-links/{id}/clicks:
    get:
      tags:
        - Short links
      summary: Listar cliques do link
      description: Lista cada clique registrado em um link curto.
      operationId: ntfShortLinks_getV1ShortLinksClicks
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID (cuid) do link.
        - name: page
          in: query
          schema:
            type: string
          description: Página (padrão 1, máx. conforme motor de paginação).
        - name: limit
          in: query
          schema:
            type: string
          description: Itens por página (padrão 20, máx. 100).
      responses:
        '200':
          description: Lista paginada de eventos de clique.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ClicksListResponse'
              examples:
                page1:
                  value:
                    success: true
                    data:
                      - id: clclick01exampleid0001
                        shortLinkId: clshort01exampleid0001
                        workspaceId: clws_example_workspace01
                        clickedAt: '2026-04-20T12:01:00.000Z'
                        ipRaw: null
                        ipHash: sha256:deadbeef...
                        userAgent: Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X)
                        referrer: https://t.co/xyz
                        utmSource: twitter
                        utmMedium: social
                        utmCampaign: launch2026
                        country: BR
                        region: SP
                        city: São Paulo
                        deviceType: mobile
                        osFamily: iOS
                        browserFamily: Mobile Safari
                    pagination:
                      page: 1
                      limit: 50
                      total: 128
                      totalPages: 3
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
        '403':
          description: Escopo `short_links:read` ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
        '404':
          description: Link inexistente ou removido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
              examples:
                notFound:
                  value:
                    success: false
                    error: Not Found
                    message: Not Found
                    code: NOT_FOUND
components:
  schemas:
    NtfShortLinks_ClicksListResponse:
      type: object
      required:
        - success
        - data
        - pagination
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/NtfShortLinks_ClickEvent'
        pagination:
          $ref: '#/components/schemas/NtfShortLinks_Pagination'
    NtfShortLinks_ErrorResponse:
      type: object
      description: Erro genérico da API v1 (short links).
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          nullable: true
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          nullable: true
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
    NtfShortLinks_ClickEvent:
      type: object
      description: Evento de clique; `clickedAt` em ISO 8601 na resposta JSON.
      properties:
        id:
          type: string
        shortLinkId:
          type: string
        workspaceId:
          type: string
        clickedAt:
          type: string
          format: date-time
        ipRaw:
          type: string
          nullable: true
        ipHash:
          type: string
          nullable: true
        userAgent:
          type: string
          nullable: true
        referrer:
          type: string
          nullable: true
        utmSource:
          type: string
          nullable: true
        utmMedium:
          type: string
          nullable: true
        utmCampaign:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        region:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        deviceType:
          type: string
          nullable: true
        osFamily:
          type: string
          nullable: true
        browserFamily:
          type: string
          nullable: true
    NtfShortLinks_Pagination:
      type: object
      required:
        - page
        - limit
        - total
        - totalPages
      properties:
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
          maximum: 100
        total:
          type: integer
          minimum: 0
        totalPages:
          type: integer
          minimum: 1
  securitySchemes:
    ntfShortLinksBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfShortLinksApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API Key no header x-api-key. Exemplo: `x-api-key: sk_live_xxxxx`'

````