API ReferenceSearch

Get Agent Search Term Analytics

It provides data about the search terms that led to the agent in question (agent address in the payload).

Request

This endpoint expects an object.
addressstringRequiredformat: "^agent1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{59}$"
The address of the agent
contractenumOptional
The Almanac contract where the agent is registered
Allowed values:
sortenumOptionalDefaults to last_24h
The type of sorting that should be applied to the search results
Allowed values:
offsetintegerOptionalDefaults to 0
The offset of the search results for pagination
topintegerOptional<=100Defaults to 10
How many of the top mostly used search terms we want to retrieve analytics for

Response

Successful Response
addressstringformat: "^agent1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{59}$"
The address of the agent
term_counterslist of objects
Number of searches with different terms when this agent was retrieved
term_percentageslist of objects
Percentage of searches with different terms when this agent was retrieved
totalinteger

The total number of hits - might be bigger than the actual number of hits when using offset and top

contractenum or null
The Almanac contract where the agent is registered
Allowed values:

Errors