---
title: "Partner Summary"
method: GET
path: "/v1/report/summary"
tags: ["Reporting"]
---

# Partner Summary

`GET /v1/report/summary`

Your monthly referral activity and earnings summary.

Use start_month and end_month to set the reporting window. Defaults to the earliest activity when omitted.
Lifetime totals span all time, regardless of the window.

## Query parameters

- `start_month` string, nullable — Window start month (inclusive), YYYY-MM
- `end_month` string, nullable — Window end month (inclusive), YYYY-MM

## Response `200`

Successful Response

- ReportSummary
  - `partner` PartnerProfile, required
    - `account_name` string, required — Your partner account name
    - `referral_code` string — The referral code these results are scoped to
    - `logo_url` string — URL to your partner logo, when configured
  - `window_start_month` string — First month of the resolved window, YYYY-MM
  - `window_end_month` string — Last month of the resolved window, YYYY-MM
  - `lifetime` LifetimeSummary, required
    - `counts` ReferralCounts, required
      - `accounts_referred` integer, required
      - `properties_contacted` integer, required — Properties contacted; equals rental_contacted + flip_contacted
      - `rental_contacted` integer, required — Rental (long-term) properties contacted
      - `flip_contacted` integer, required — Fix-and-flip properties contacted
    - `transaction_count` integer, required — Number of transactions across all time
    - `referral_fees` string, required — Referral fees accrued across all time, in dollars
    - `payments` string, required — Payments issued to you across all time, in dollars
    - `floor_month` string — Earliest month with activity, YYYY-MM
  - `monthly` MonthlySummary[], required — Per-month breakdown within the window, oldest to newest
    - `month` string, required — Calendar month, YYYY-MM
    - `counts` ReferralCounts, required
      - `accounts_referred` integer, required
      - `properties_contacted` integer, required — Properties contacted; equals rental_contacted + flip_contacted
      - `rental_contacted` integer, required — Rental (long-term) properties contacted
      - `flip_contacted` integer, required — Fix-and-flip properties contacted
    - `rental_referral_fee` string, required — Per-rental-referral fee rate applied this month, in dollars
    - `flip_referral_fee` string, required — Per-flip-referral fee rate applied this month, in dollars
    - `referral_fees` string, required — Referral fees accrued this month, in dollars
    - `payments` string, required — Payments issued to you this month, in dollars
    - `transaction_count` integer, required — Number of transactions in this month
    - `transactions` ReferralTransaction[], required — Transactions recorded in this month; empty when there are none
      - `transaction_id` string, required
      - `transaction_at` string, date-time, required — When the transaction was recorded
      - `rental_referral_fee` string — Per-rental-referral fee override on this transaction, when set, in dollars
      - `flip_referral_fee` string — Per-flip-referral fee override on this transaction, when set, in dollars
      - `transaction_amount` string, required — Total amount of the transaction, in dollars

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/steadily/apis/steadily-partner-api.md) · [All operations](https://skmtc.net/steadily/apis/steadily-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steadily/steadily-partner-api/versions/ac329ca07dbb/schema)