SimilarWeb Digital Rank API connects to a Nagent workspace with an API key. Once it is connected, agents can call 3 SimilarWeb Digital Rank API actions: "Get Rank Tracker Campaign Metadata", "Get Similar Rank Top Sites" and "Get Subscription Status". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against SimilarWeb Digital Rank API, with input parameters and output schema.
SIMILARWEB_DIGITALRANK_API_GET_RANK_TRACKER_DESCRIBETool to retrieve campaign metadata for rank tracking. Returns Campaign IDs and Scraping Configurations needed to query other Rank Tracker APIs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMILARWEB_DIGITALRANK_API_GET_SIMILAR_RANK_TOP_SITESTool to retrieve a list of top-ranking websites globally or filtered by country and category. Use when you need to discover popular websites based on SimilarWeb's traffic data.
Input parameters
Maximum number of top sites to return. Controls pagination of results.
Country code to filter top sites by specific country (e.g., 'us', 'gb', 'fr'). If not provided, returns global top sites.
Category to filter top sites by specific industry or topic (e.g., 'shopping', 'news', 'social_media'). If not provided, returns all categories.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SIMILARWEB_DIGITALRANK_API_GET_SUBSCRIPTION_STATUSTool to check the remaining subscription usage for the user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 3 SimilarWeb Digital Rank API actions on Nagent: "Get Rank Tracker Campaign Metadata", "Get Similar Rank Top Sites" and "Get Subscription Status". Get Rank Tracker Campaign Metadata: Retrieve campaign metadata for rank tracking. Each action is listed on this page with its input parameters and its output.
SimilarWeb Digital Rank API connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.