lookupStore
Look up a store
Look up one ecommerce store by domain. The reply has company data, estimated revenue, marketing budget, traffic, Google and Meta ad spend, ad counts, a Conversion Rate Score, buying signals, the store phone number, and social and ad-library links. Decision-maker contact fields are not in the fields list. With OAuth access, the decisionMakers object shows the contacts that you revealed. When other active stores use the same base domain, the reply has sharedMetrics. Those stores show the same traffic and ad numbers, because the data belongs to the base domain. Limits: anonymous access, 20 lookups per hour per IP. OAuth access, 20 lookups per minute, and the call writes a lookup history row.
Parametersdomainrequired
searchStores
Search stores
Search the store catalog like the Ecommerce Leads dashboard. Returns 30 rows per page. Stores you have not revealed show masked values for the hidden fields; revealed stores show the real values. By default, each row has storeId, 9 key columns (Industry, Country, revenue, Total Traffic, Google and Meta ad spend, Buying Signals, Buying Signals List, Status) and a short "reveal" object (revealed, contactTypes, pendingTypes). Use the columns argument to choose other columns, or ["*"] for all columns and the full reveal object. The result has the column list only when includeColumns is true. The result has the exact total. If the count fails, the result has totalAtLeast (a lower bound that grows on each page) and a note. Use hasMore to decide whether to fetch the next page, and do not report totalAtLeast as the number of matches. When other active stores use the same base domain, the row has sharedMetrics {basedomain, relatedStoreCount}. Those stores show the same traffic and ad numbers, because the data belongs to the base domain.
ParameterstabpagesortcolumnsfiltersincludeColumns
getStoreChart
Get store metric chart
Get the latest 24 points of one metric for a store, for a chart. Values use your currency.
Parametersdomainrequiredmetricrequired
listSignalSets
List signal sets
List your signal sets, with the signal catalog and the ICP columns you can use in criteria. Paid plans only.
Takes no parameters.
getSignalSet
Get a signal set
Get one of your signal sets, with its criteria. Paid plans only.
ParameterssetIdrequired
previewSignalSet
Preview a signal set
Check whether candidate signal criteria match enough stores (80 or more). Returns {"enough": true|false}. It does not save anything. Paid plans only.
ParameterssetIdcriteriarequired
listWatchlists
List watchlists
List your watchlists and your blacklist, with the domain count of each. Paid plans only.
Takes no parameters.
getWatchlist
Get a watchlist
Get the domains of one watchlist or the blacklist, 100 per page. To see store data for a watchlist, call searchStores with tab "watchlist:{id}". Paid plans only.
ParameterspagelistIdrequired
getRevealCost
Get reveal cost
Preview the credit cost of a reveal. Nothing is charged and nothing is revealed. Returns the cost of each action (details, ceo, marketing, ecommerce) for the selected stores.
Parametersselectionrequired
getRevealStatus
Get reveal status
Check the status of contact searches you started in the dashboard, and your credit balance. Read only.
ParametersstoreIdsrequired
revealStores
Reveal stores (spends credits)
Reveal data for stores. THIS SPENDS CREDITS. Before you call it, call getRevealCost for the same selection and tell the user the cost, or state the cost of 1 credit per store, then ask the user to confirm. Never call it without the confirmation. details unlocks the profile links, buying signals and phone. ceo, marketing and ecommerce start a decision-maker contact search (1 credit per store, +1 for a store whose details are not revealed yet). A store you already revealed costs 0. If you have too few credits, the result shows the cost and your balance, and nothing is charged. Use getRevealStatus to follow a contact search.
Parametersactionrequiredselectionrequired
saveSignalSet
Save a signal set
Create a signal set, or replace the criteria of an existing one. Without setId it creates a new set (the plan limit applies). With setId it updates that set and replaces all its signals, legacy categories and ICP filters with the new criteria. Conditions that you did not set (saved custom SQL conditions) stay on the set, joined with AND. Then the reply has preservedConditions, the number of these conditions. Use previewSignalSet first to check that the criteria match enough stores. Paid plans only.
ParametersnamesetIdcriteriarequired
deleteSignalSet
Delete a signal set
Delete one of your signal sets. The set stops matching stores and disappears from listSignalSets and from the dashboard tabs. You cannot undo this. Ask the user to confirm before you call it. Say the name of the set in your question. Paid plans only.
ParameterssetIdrequired
createWatchlist
Create a watchlist
Create an empty watchlist. You can have at most 10 lists, including the blacklist. Paid plans only.
Parametersnamerequired
renameWatchlist
Rename a watchlist
Rename one of your watchlists. The blacklist cannot be renamed. Paid plans only.
ParametersnamerequiredlistIdrequired
deleteWatchlist
Delete a watchlist
Delete one of your watchlists with all its domains. The blacklist cannot be deleted. Ask the user to confirm before you call it. Paid plans only.
ParameterslistIdrequired
removeFromWatchlist
Remove stores from a watchlist
Remove one domain from a watchlist or from the blacklist. Paid plans only.
ParametersdomainrequiredlistIdrequired
addToWatchlist
Add stores to a watchlist (spends credits)
Add domains to a watchlist (merge, nothing is removed). THIS SPENDS CREDITS: 1 credit per domain that is new to the list. Before you call it, tell the user the cost of 1 credit per store and how many domains you will add, then ask the user to confirm. Never call it without the confirmation. If you have too few credits, the result shows the cost and your balance, and nothing is added. Paid plans only.
ParameterslistIdrequireddomainsrequired
updateOutreachStatus
Update outreach status
Set the outreach status of one store that you revealed. Use the storeId from a searchStores row. If you did not reveal the store, the tool returns an error. Use revealStores first. A store in a revealed group is accepted at no credit cost.
ParametersstatusrequiredstoreIdrequired
sendFeedback
Send feedback
Send a feedback message to the Ecommerce Leads team. Limit: 5 messages per hour.
Parametersmessagerequired
exportStores
Export revealed stores
Export revealed stores as CSV text. Stores you have not revealed are skipped. The result holds the header row and at most 200 data rows; it says when it cut the rows. For a larger export, narrow the selection or download the file in the dashboard. Paid plans only.
ParametersselectionrequiredvisibleColumns