Searches locations - Doofinder API Reference

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}$

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}$

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

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

Locations retrieved.

Searches locations result.

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[]

Show child attributes