Skip to main content
GET
/
api
/
v2
/
stats
/
searches
/
top
Top searches
curl --request GET \
  --url https://{search_zone}-api.doofinder.com/api/v2/stats/searches/top \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "count": 12,
      "query": "some term"
    }
  ],
  "total": 1,
  "total_count": 12
}

Authorizations

​
Authorization
string
header
required

Doofinder API key. Pass it as: Authorization: Token <api_key>

Query Parameters

​
from
string
required

Start date of the period in the format of UNIX timestamp or YYYYMMDD.

Pattern: ^20\d{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$|^\d{10}|^\d{13}$
​
to
string
required

End date of the period in the format of UNIX timestamp or YYYYMMDD.

Pattern: ^20\d{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$|^\d{10}$|^\d{13}
​
hashids
string[]

Unique id of the search engine. It accepts an array of values. If you want to work with all user search engines just don't send this parameter. Arrays parameters must be in the format param[]=value.

Pattern: ^[a-f0-9]{32}$
​
hashid
string[]
Pattern: ^[a-f0-9]{32}$
​
tz
string
default:Etc/UTC

The timezone for the given dates, by default, assumes ETC/UTC. In naming your time zones, you must stick to those indicated in the TZ database name column here

​
device
enum<string>

Filter by kind of device.

Available options:
desktop,
mobile
​
format
enum<string>
default:json

Indicates which response format should be used

Available options:
json,
csv
​
query_name
string[]

Type of query to filter by. Arrays parameters must be in the format param[]=value.

​
total_hits
integer

Filter by the number of search results.

​
no_results
boolean

Show only searches that exclusively yielded 0 results.

​
opportunities
boolean

Show only searches that exclusively had "fuzzy" or "phonetic_text" as query name.

​
exclude
object

Exclude filters

​
aggregate
boolean
default:true

Flag to indicate when to aggregate all Search Engines stats data.

​
indices
object

Filter by index name.

Parameters:

  • name *: The name of the index to filter
  • hashid *: The hashid where name belongs

Format: indices[i][name]=value&indices[i][hashid]=hashid.

​
query
string

An string used to filter stats by input query.

​
dfid
string

Filter by a doofinder item id. You can get this value from the playground.

Response

Stats retrieved.

Stats results for top searches.

​
total
integer

Sum of all elements retrieved.

Example:

1

​
total_count
integer

Total sum of all elements count. If element does not have a "count", this has the same value as total.

Example:

12

​
results
object[]