analytics

Whether the current search query counts towards analytics

The analytics parameter controls whether a search query is recorded in Algolia Analytics. This lets you exclude specific queries from analytics reporting.

Usage

• If true (default), the query is tracked and included in analytics reports.
• If false, the query is excluded from analytics.

Example

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", Analytics = false })
);

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    analytics: false,
  ),
);

response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("query").SetAnalytics(false))))
if err != nil {
  // handle the eventual error
  panic(err)
}

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setAnalytics(false),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', analytics: false },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", analytics = false),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'analytics' => false,
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "analytics": False,
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", analytics: false)
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        analytics = Some(false)
      )
    )
  ),
  Duration(100, "sec")
)

let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "query",
        analytics: false
    ))
)

Legacy API clients

C#

index.Search(new Query("")
{
    Analytics = false
});

res, err := index.Search(
	"query",
	opt.Analytics(false),
)

index.search(
  new Query("query")
    .setAnalytics(false)
);

index
  .search("query", {
    analytics: false,
  })
  .then(({ hits }) => {
    console.log(hits);
  });

val query = query("query") {
    analytics = false
}

index.search(query)

$results = $index->search('query', [
  'analytics' => false
]);

results = index.search("query", {"analytics": False})

results = index.search(
  "query",
  {
    analytics: false
  }
)

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    analytics = Some(false)
  )
}

let query = Query("query")
  .set(\.analytics, to: false)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}