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

# List all clicks



## OpenAPI

````yaml /api-reference/openapi.json get /clicks/
openapi: 3.0.3
info:
  title: Tapfiliate REST API
  version: '1.6'
  description: >-
    Reference for the Tapfiliate REST API. See the introduction for
    authentication, pagination and rate limits.
  x-generated-from: ApiBlueprint@e23e51f
servers:
  - url: https://api.tapfiliate.com/1.6
    description: Production
security:
  - ApiKey: []
tags:
  - name: Customers
    description: >-
      People who signed up or paid after being referred by an affiliate. With
      recurring or lifetime commissions, later conversions for the same customer
      go to the same affiliate.
  - name: Conversions
    description: >-
      Sales and other actions you pay commissions for. Each conversion has one
      or more commissions.
  - name: Commissions
    description: >-
      What an affiliate earns for a conversion. Approve or disapprove them
      before payout.
  - name: Affiliates
    description: >-
      The partners who promote your programs, with their meta data, notes,
      payout methods and balances.
  - name: Affiliate Groups
    description: Groups for organising your affiliates.
  - name: Affiliate Prospects
    description: >-
      People who signed up through a recruitment source but are not affiliates
      yet.
  - name: Programs
    description: >-
      Your affiliate programs, the affiliates in them and their commission
      settings.
  - name: Payments
    description: Settle affiliate balances and look up past payments.
  - name: Clicks
    description: Visits through affiliate links, the first step of attribution.
paths:
  /clicks/:
    get:
      tags:
        - Clicks
      summary: List all clicks
      operationId: listAllClicks
      parameters:
        - name: program_id
          in: query
          description: The program Id
          example: johns-affiliate-program
          schema:
            type: string
        - name: affiliate_id
          in: query
          description: The affiliate Id
          example: janejameson
          schema:
            type: string
        - name: date_from
          in: query
          description: Date From, a day in UTC
          example: '2022-01-01'
          schema:
            type: string
        - name: date_to
          in: query
          description: Date To, a day in UTC
          example: '2099-12-31'
          schema:
            type: string
        - name: >-
            meta_data (optional, array) ... Meta Data value filter, example
            meta_data[key]
          in: query
          description: ''
          required: true
          schema:
            type: string
            default: subid1&meta_data[value]=baz
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClicksCollectionModel'
              example:
                - id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                  created_at: '2023-12-14T00:00:00+00:00'
                  meta_data:
                    - key: subid1
                      value: baz
                  details:
                    os: Mac OS X
                    os_version: 10.15.1
                    browser: Chrome
                    browser_version: '81'
                    referrer: https://example-blog.inc/check-out-johns-product/
                    platform: Desktop
                    landing_page_url: https://tapper.inc/johns-cool-product/
                  geolocation:
                    country: United States
                    country_code: US
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    ClicksCollectionModel:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
          created_at:
            type: string
          meta_data:
            type: array
            items:
              type: object
              properties:
                key:
                  type: string
                value:
                  type: string
          details:
            type: object
            properties:
              os:
                type: string
              os_version:
                type: string
              browser:
                type: string
              browser_version:
                type: string
              referrer:
                type: string
              platform:
                type: string
              landing_page_url:
                type: string
          geolocation:
            type: object
            properties:
              country:
                type: string
              country_code:
                type: string
    ErrorList:
      type: object
      description: Business and validation errors raised by an endpoint.
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
                description: Machine-readable code, on 409 responses.
              property_path:
                type: string
                description: The invalid field, on validation errors.
            required:
              - message
      required:
        - errors
    RequestError:
      type: object
      description: >-
        Errors raised before the endpoint runs: authentication, access, unknown
        path, server error.
      properties:
        message:
          type: string
        code:
          type: integer
        traceId:
          type: string
          description: Send this to support to find the request.
      required:
        - message
        - code
  responses:
    BadRequest:
      description: The request is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorList'
          example:
            errors:
              - message: Missing mandatory parameter(s)
    Unauthorized:
      description: The API key is missing or wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Authentication Failed.
            code: 401
    Forbidden:
      description: No API access or no permission for this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Forbidden
            code: 403
            traceId: 04ed655728a22bc0d39f
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Your API key, from your Tapfiliate account settings.

````

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