RuusterAPI Reference
Menu · Brokerage
Brokerage

Get your account's highlights

GEThttps://api.ruuster.com/v1/wins

Highlights for the brokerage in one call. Figures that grew against the previous period of the same length, the most-viewed listings, the most engaged leads, agent activity, the hottest areas with Ruuster's share of listing views, and, for Follow Up Boss accounts, dormant leads re-engaged after a Ruuster touch. Highlights only; for every figure, including those that fell, use summary.

  • Authentication: x-api-key and x-email headers of an owner or admin
  • Rate limit: 120 requests per minute per key
  • Rows count against the daily lead-row quota (50,000 by default)
View as Markdown

What is going well on your account, gathered from the other endpoints and put in plain sentences. Use it for a "what has Ruuster done for us" recap, a renewal or QBR slide, or a team shout-out.

This endpoint reports highlights, not a full picture. A figure is shown three ways:

  • Grew: it rose against the previous period of the same length, and both periods are covered by Ruuster's records. The figure comes with previous and growthPct; a growthPct of null means up from zero.
  • Volume: it is above zero but didn't grow, or the earlier period isn't covered. Only value is given, with no comparison.
  • Left out: it is zero or unknown.

So a figure that fell appears without a comparison, and /wins never states a decline. For the complete numbers, ups and downs alike, use Get the brokerage summary.

What the sections are based on:

  • Engagement comes from the same records as /summary. engagedLeads counts the distinct leads active on Ruuster in the period. nurturedClients is the figure from Ruuster's weekly analytics email. New leads and sign-ups are not included: Ruuster mostly works existing and cold leads, so engagement is the measure, and lead counts include contacts imported from your CRM.
  • Top listings are your own listings, ranked by views as in Rank your listings' engagement.
  • Top leads are the most active leads, as in List active leads.
  • Agents counts the people on your account, the agents added in the period, and agents' own activity.
  • Markets is the leads map for the last 30 days with sources=1. It covers listing views on Ruuster and listing views your CRM recorded from other sources (portals, IDX sites). An area counts as led by Ruuster when more than half of its views were on Ruuster, and the share is given only for those areas. It is never over 30 days, whatever range you ask for, because listing activity is kept for 30 days.
  • Wake-ups are for Follow Up Boss accounts only:
    • A lead counts as woken when it had no activity on either side (calls, texts, appointments, deals, Ruuster) for at least minDarkDays before a Ruuster touch.
    • A meeting counts when it was booked after a Ruuster touch.
    • This is the same data as Ruuster Impact. It shows that a touch came before a meeting, not that the touch caused it.
    • verified stories passed the stricter check that Ruuster's published wake-up stories use.
    • History starts at historyFrom and runs through historyThrough. When that is earlier than the end of your range, the wake-up figures stop there.
    • No deal, contract or sale figures are included.

Query parameters

Name Type Default Description
from date 28 days before to First day, YYYY-MM-DD in America/Chicago, included. With neither date, the last 4 complete weeks (Monday to Monday)
to date the start of this week Day after the last day, YYYY-MM-DD, excluded. At most 182 days after from
minDarkDays 30 | 90 | 180 | 365 90 How long a lead must have been quiet to count as woken up
agent string your default agent Whose page the topListings links (url) open under: an agentId, email or landing-page slug from List agents. Whoever signs up from such a link becomes that agent's lead. Without it, links credit your brokerage's default agent (where unassigned leads go). meta.agent names the agent credited

Response

Field Description
headlines Up to 6 sentences, strongest first, written from the figures below
engagement engagedLeads (distinct leads active on Ruuster), nurturedClients, listingViews, clientActivities, favorites, savedSearches, tourRequests, contactAgentClicks, searches, emailOpens (human opens), emailClicks: each { value, previous?, growthPct? }
records Weeks that beat every other complete week in the two periods: metric, week (its Monday), value, weeksCompared
topListings Up to 5 of your listings: propertyId, address, mlsRecordId, url, views (signed-in and public), uniqueLeads, favorites, tourRequests
topLeads Up to 5 leads: lead (leadId, firstName, lastName, email, phone, crmExternalId, crmStatus, agentId), actions, propertyViews, favorites, tourRequests, lastActivityAt
agents activeAgents (people on your account), newAgents (added in the period), agentPageViews, agentSavedSearches (saved searches agents set up for clients)
markets range, ruusterLedAreas, topAreas (up to 5: city, state, leads, views, favorites, and ruusterShare with ruusterLed: true where Ruuster leads), and map: the leads map response with groupBy=listing and sources=1, so every property is its own point (up to 600 of yours, plus other-source points)
wakeups leadsTouched, leadsWoken, longestDarkDays, wokenWhoBooked, meetingsAfterRuuster, meetingsRuusterLastTouch, verifiedWakeups, historyFrom, historyThrough, and stories (up to 5: leadId when the lead is on Ruuster, name, darkDays, wokeAt, wokeBy, meetingBookedAt, verified)

A section with nothing to show is left out. meta.comparedWith is the earlier period. meta.unavailable names any section that couldn't be read just then; try again later for it. Names follow your lead-contact-details setting: with it off, a story's name is shortened to "Karin M.". Leads in topLeads and wakeups.stories count against the daily lead-row quota.