Logs a banner image click - Doofinder API Reference

PUT

{hashid}

stats

image

Logs a banner image click

curl --request PUT \
  --url https://{search_zone}-search.doofinder.com/6/{hashid}/stats/image \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "session_id": "<string>",
  "query": "<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

string

required

The id of the banner clicked

session_id

string

required

Identifier of search session

Maximum string length: 32

query

string

The search query that led to this

Response

Response returned over register stat operation.

status

string

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

Init sessionStarts a session identified by a session_id. The session is used to "group" events. I.e. it groups user interactions during a session. Like clicking some banner images, or completing a checkout.

Logs a banner image click

curl --request PUT \
  --url https://{search_zone}-search.doofinder.com/6/{hashid}/stats/image \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "session_id": "<string>",
  "query": "<string>"
}
'

{
  "status": "registered"
}