API ReferenceAd Network Reports

Get ad network report summary OAuth Scope: posts:read

<Note title="Currently in beta" icon="b"> This feature is currently in beta and the API is subject to change.<br/> </Note> Retrieve aggregate advertisement performance and revenue for a publication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"
The prefixed ID of the publication object.

Query parameters

start_datedateOptional

Include reports for advertisements sent on or after this date in YYYY-MM-DD format.

end_datedateOptional

Include reports for advertisements sent on or before this date in YYYY-MM-DD format.

Response

OK
opensinteger
The total approved number of unique opens.
verified_clicksinteger
The total approved number of verified clicks.
revenuestring
The total formatted revenue approved for payment.
odaobject

Metrics for advertisements accepted as on-demand offers.

programmaticobject
Metrics for advertisements placed through programmatic ad slots.
publication_idstringOptionalformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed publication ID. Omitted from account-wide summaries.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error