Base URL
https://eu1-api.doofinder.com
Authentication
Common Query Parameters
Most endpoints accept these parameters to define the reporting window:| Parameter | Type | Description |
|---|---|---|
hashid | string | Required. Your search engine’s identifier. |
from | string | Start date in YYYY-MM-DD format. |
to | string | End date in YYYY-MM-DD format. |
tz | string | Timezone for date aggregations (e.g. Europe/Madrid). |
Endpoint Groups
Usage & Sessions
Session counts, user activity, geographic breakdowns, and per-engine usage.
Searches
Search volume, top queries, popular terms, location data.
Clicks & Interactions
Click-through rates, clicked items, position analysis, redirects.
Conversions & Sales
Checkout and sales data attributed to search sessions.
Features
Banners, facets, custom results, recommendations, quizzes.
Usage & Sessions
Track how users are engaging with your search engine over time.| Method | Path | Description |
|---|---|---|
GET | /api/v2/stats/inits | Total session counts over time |
GET | /api/v2/stats/inits/locations | Sessions broken down by geographic location |
GET | /api/v2/stats/inits/users | Sessions with identified users |
GET | /api/v2/stats/usage | Overall usage metrics |
GET | /api/v2/stats/search_engine_users | Per-engine usage by user |
Searches
Understand what your users are searching for.| Method | Path | Description |
|---|---|---|
GET | /api/v2/stats/searches | Search volume over time |
GET | /api/v2/stats/searches/top | Top search queries ranked by volume |
GET | /api/v2/stats/searches/popular | Popular searches (trending) |
GET | /api/v2/stats/searches/locations | Searches broken down by location |
GET | /api/v2/stats/results/top | Most-returned results across searches |
Clicks & Interactions
Measure how users interact with search results.| Method | Path | Description |
|---|---|---|
GET | /api/v2/stats/clicks | Click volume over time |
GET | /api/v2/stats/clicks/users | Clicks attributed to identified users |
GET | /api/v2/stats/clicked_items | Items most frequently clicked |
GET | /api/v2/stats/clicked_items/searches | Searches that led to clicks on each item |
GET | /api/v2/stats/clicked_items/position | Average click position per item |
GET | /api/v2/stats/redirects | Redirect rule trigger counts |
Conversions & Sales
Attribute revenue and conversions to search-driven sessions.| Method | Path | Description |
|---|---|---|
GET | /api/v2/stats/checkouts | Checkout events initiated from search sessions |
GET | /api/v2/stats/sales | Sales data |
POST | /api/v2/stats/sales | Confirm a sale event |
GET | /api/v2/stats/top-sales | Top-selling items attributed to search |
POST | /api/v2/stats/carts | Process checkout cart data |
Features
Track usage of specific Doofinder features.| Method | Path | Description |
|---|---|---|
GET | /api/v2/stats/banners | Banner impression and click stats |
GET | /api/v2/stats/facets | Facet usage — which filters users apply |
GET | /api/v2/stats/facets_by_day | Daily facet usage breakdown |
GET | /api/v2/stats/facets/top | Top facet values by usage |
GET | /api/v2/stats/custom-results | Custom result rule usage |
GET | /api/v2/stats/recommendations | Recommendation widget stats |
GET | /api/v2/stats/quizzes | Quiz feature stats |
GET | /api/v2/stats/sector/{name} | Industry-specific benchmark data |
POST | /api/v2/stats/visit | Log a page visit event |
Key Metrics Explained
Click-Through Rate (CTR)
The ratio of search sessions that result in at least one click. A low CTR on a query suggests results are not relevant.Zero Results Rate
The percentage of searches that return no results. MonitorGET /api/v2/stats/searches for queries with total_results: 0.