Skip to main content
GET
/
2
/
hits
curl
curl --request GET \
  --url 'https://analytics.us.algolia.com/2/hits?index=ALGOLIA_INDEX_NAME&search=enable%20ab%20test&clickAnalytics=false&revenueAnalytics=false&startDate=2022-09-19&endDate=2023-01-21&limit=10&offset=0&tags=device%3Amobile%2520phone' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "hits": [
    {
      "hit": "method-export-rules-php",
      "count": 2
    }
  ]
}
Required ACL: analytics

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

​
index
string
required

Index name.

Example:

"ALGOLIA_INDEX_NAME"

​
search
string

Search query.

​
clickAnalytics
boolean
default:false

Whether to include metrics related to click and conversion events in the response.

​
revenueAnalytics
boolean
default:false

Whether to include metrics related to revenue events in the response.

​
startDate
string

Start date of the period to analyze, in YYYY-MM-DD format.

Example:

"2022-09-19"

​
endDate
string

End date of the period to analyze, in YYYY-MM-DD format.

Example:

"2023-01-21"

​
limit
integer
default:10

Number of items to return.

Required range: x <= 1000
​
offset
integer
default:0

Position of the first item to return.

Required range: x >= 0
​
tags
string

Tags by which to segment the analytics.

You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.

Response

OK

  • Top search results
  • Top search results with click analytics
  • Top search results with revenue analytics
​
hits
topHit · object[]
required

Most frequent search results.

⌘I