Objects
Every object the Partner API v1 returns, with each field's type and meaning.
Response objects referenced by the token and reports reference pages. Clients must ignore fields they do not recognize; new optional fields can appear within v1.
Error
See errors for every code and when to retry.
errorobjectRequirederror.codestringRequiredMachine-readable code. Current values: invalid_request, unauthorized, forbidden, not_found, method_not_allowed, conflict, rate_limited, internal_error, unavailable. New codes may be added; treat an unknown code by its HTTP status.
error.messagestringRequirederror.request_idstring | nullPingResult
organizationobjectRequiredorganization.idstring (uuid)Requiredorganization.namestringRequiredtokenobjectRequiredtoken.key_idstringRequiredtoken.scopesarray of ScopeRequiredSee Scope.
token.expires_atstring (date-time) | nullRequiredScope
Type: string.
reporting:read today. New scopes may be added.
RevenueReportMeta
next_cursorstring | nullRequireddata_throughstring (date) | nullRequiredLatest UTC date with loaded revenue, or null if nothing is loaded for the range.
RevenueRow
Field meanings and when numbers change are covered in revenue reports.
datestring (date)Requiredpublisher_idstring (uuid)Requiredprimary_domainstringRequiredThe publisher's primary domain, lowercase, with no scheme or path. Revenue from the publisher's alternate domains is included in its row.
gross_revenuenumberRequiredWhat ad partners paid for your organization's ad traffic on this publisher, before the revenue share, rounded to 6 decimal places.
net_revenuenumberRequiredYour organization's share of gross_revenue, rounded to 6 decimal places.
impressionsintegerRequiredPaid ad impressions reported by ad partners.
currencystringRequiredISO 4217 code. Always USD today.
is_finalbooleanRequiredTrue when ad partner data for the date is final (two or more UTC days old). A revenue share change can still restate net_revenue.