Get Reports

Returns the user's owner reports with their totals, a page at a time. An owner report is one listing group's statement for one calendar month, as Owner Statements makes it: drafts and published ones. Lines aren't included: Get Report returns them. Requires the ownerStatements:read scope.

Send any of listingGroupID, month and status, or updatedSince:

  • With the filters (or none), reports come newest month first, with total.
  • updatedSince returns every report created or changed at or after that time, oldest change first: a new draft, or a draft whose totals were computed again or that was published, for example. Use it to keep a copy in sync: save the time just before each call, minus a minute for clock differences, and pass it as updatedSince on the next call. It takes no other filter, since a draft that gets published would otherwise drop out of a status filter unseen. Keep reports by _id: a read can return one you already have.

A published report is frozen: its totals never change, and it is never deleted. A draft is computed from the ledger, so its numbers move with bookings, payouts and expenses without the report itself changing, and updatedSince doesn't see that. A draft's totals here are as of computedAt; Get Report computes the draft as it is now, and Refresh Report updates totals. A draft can be deleted in Host Tools: it then stops being returned, by updatedSince too, and Get Report answers 404. A report being published also sends an ownerReport.published webhook (/webhooks/ownerReport). Drafts send none, so poll for them with updatedSince.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Only this listing group's reports (from Get Listing Groups)

string

Only this month's reports (YYYY-MM)

string
enum

Only drafts, or only published reports

Allowed:
date-time

Instead of the filters: every report created or changed at or after this time (ISO 8601 date-time). Can't be combined with listingGroupID, month or status; a request that does returns 400.

integer
1 to 200
Defaults to 100

Maximum number of reports in one page (1-200). Defaults to 100.

string

The nextCursor value from the previous page, sent with the same other parameters. Treat it as an opaque string: don't build or change it yourself.

Headers
string

Partner API key (deprecated — use OAuth 2.0 for new integrations)

string

User's authentication token (legacy). Use Authorization Bearer header for new integrations.

Responses

403

The OAuth token doesn't have the ownerStatements:read scope

429

Too many requests

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json