Reporting

Partner Summary

Changed on Oct 22, 2026

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.

get/v1/report/summary

Request

Base URL
https://api.steadily.com (the document declares no server; this is the origin it was published from)
URL
https://api.steadily.com/v1/report/summary
Auth
- API key in query parameter X-Steadily-SecretKey
- or API key in header X-Steadily-SecretKey

Query parameters

start_monthstring nullable

Window start month (inclusive), YYYY-MM

end_monthstring nullable

Window end month (inclusive), YYYY-MM

Response

Successful Response

window_start_monthstring nullable

First month of the resolved window, YYYY-MM

window_end_monthstring nullable

Last month of the resolved window, YYYY-MM

Example response

{
  "monthly": [
    {
      "month": "2026-05"
    }
  ]
}

Changes

Oct 22, 202628ec84365d3e Revision changes
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
Oct 3, 2026a02c0e8f1905 Revision changes
- breaking
  response property monthly/items/transactions/items/flip_referral_fee list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property monthly/items/transactions/items/rental_referral_fee list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property partner/logo_url list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property partner/referral_code list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property window_end_month list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property window_start_month list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  the response's property type changed from no type to object for status
- info
  added the optional property / to the response with the status
- info
  removed from the response property allOf list for the response status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status

Operation history