openapi: 3.0.2
info:
  title: Analytics API
  description: API powering the Analytics feature of Algolia.
  version: 0.1.0
components:
  securitySchemes:
    appId:
      $ref: '../common/securitySchemes.yml#/appId'
    apiKey:
      $ref: '../common/securitySchemes.yml#/apiKey'
servers:
  - url: https://analytics.{region}.algolia.com
    variables:
      region:
        enum:
          - us
          - de
        default: us
  - url: https://analytics.algolia.com
security:
  - appId: []
    apiKey: []
tags:
  - name: analytics
    description: Analytics API reference.
paths:
  # ######################
  # ### Custom request ###
  # ######################
  /1{path}:
    $ref: '../common/paths/customRequest.yml'

  # ##################################
  # ### Search Analytics Endpoints ###
  # ##################################
  /2/searches:
    $ref: 'paths/search/getTopSearches.yml'
  /2/searches/count:
    $ref: 'paths/search/getSearchesCount.yml'
  /2/searches/noResults:
    $ref: 'paths/search/getSearchesNoResults.yml'
  /2/searches/noClicks:
    $ref: 'paths/search/getSearchesNoClicks.yml'
  /2/searches/noResultRate:
    $ref: 'paths/search/getNoResultsRate.yml'
  /2/searches/noClickRate:
    $ref: 'paths/search/getNoClickRate.yml'
  /2/hits:
    $ref: 'paths/search/getTopHits.yml'
  /2/users/count:
    $ref: 'paths/search/getUsersCount.yml'
  /2/filters:
    $ref: 'paths/search/getTopFilterAttributes.yml'
  /2/filters/{attribute}:
    $ref: 'paths/search/getTopFilterForAttribute.yml'
  /2/filters/noResults:
    $ref: 'paths/search/getTopFiltersNoResults.yml'
  /2/countries:
    $ref: 'paths/search/getTopCountries.yml'

  # #################################
  # ### Click Analytics Endpoints ###
  # #################################
  /2/clicks/averageClickPosition:
    $ref: 'paths/click/getAverageClickPosition.yml'
  /2/clicks/positions:
    $ref: 'paths/click/getClickPositions.yml'
  /2/clicks/clickThroughRate:
    $ref: 'paths/click/getClickThroughRate.yml'
  /2/conversions/conversionRate:
    $ref: 'paths/click/getConversionRate.yml'

  # ########################
  # ### Status Endpoints ###
  # ########################
  /2/status:
    $ref: 'paths/status/getStatus.yml'