Skip to main content
PUT
/
6
/
{hashid}
/
stats
/
click
Click stats
curl --request PUT \
  --url https://{search_zone}-search.doofinder.com/6/{hashid}/stats/click \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dfid": "<unknown>",
  "session_id": "<string>",
  "custom_results_id": "<string>",
  "user_id": "<string>",
  "query": "<string>",
  "position": 123,
  "resource_id": "<string>"
}
'
{
  "status": "registered"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
hashid
string
required

Unique id of a search engine.

Body

application/json
​
dfid
any
required
​
session_id
string
required

Identifier of search session

Maximum string length: 32
​
custom_results_id
string

Identifier of the custom result the search results belongs to.

​
user_id
string

Identifier of user

Maximum string length: 36
​
query
string

The search query that led to this

​
position
integer

The position the clicked item have in the search results. The first position should be 1.

​
resource_id
string

Identifier of the resource that generated the click

Response

OK

Response returned over register stat operation.

​
status
string

Result of the stats request. i.e. 'registered'