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:
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_percentageslist of objects
Percentage of searches with different terms when this agent was retrieved
contractenum or null
The Almanac contract where the agent is registered
Allowed values:

Errors