Get Advertiser Performance Report
  • 09 Dec 2024
  • Dark
    Light

Get Advertiser Performance Report

  • Dark
    Light

Article summary

Get
/publishers/{publisherId}/reports/advertiser

This API is Available on Zapier

Automate your workflows with Zapier's easy to use workflow builder. Read more here or go directly our Zapier Integration Page


GET reports aggregated by advertiser

The advertiser performance report aggregates transactions, clicks and impressions for all advertisers a publisher works with.


Who can use it

Publishers 

Header parameters
Authorization
string

accessToken

Path parameters
publisherId
integer (int64) Required

publisher id

Query parameters
accessToken
stringRequired

access token

dateType
string

date type, if not set - 'transaction' is the default

Valid values[ "\"transaction\"", "\"validation\"" ]
Default"transaction"
endDate
string (date) Required

end date

Default"2021-03-15"
region
stringRequired

region

Valid values[ "\"AT\"", "\"AU\"", "\"BE\"", "\"BR\"", "\"BU\"", "\"CA\"", "\"CH\"", "\"DE\"", "\"DK\"", "\"ES\"", "\"FI\"", "\"FR\"", "\"GB\"", "\"IE\"", "\"IT\"", "\"NL\"", "\"NO\"", "\"PL\"", "\"SE\"", "\"US\"" ]
Default"GB"
startDate
string (date) Required

start date

Default"2021-01-01"
timezone
string

time zone in short or default format

Default"UTC"

Further details on query parameters

parameterformatmandatory/optional
startDateyyyy-MM-ddmandatory
endDateyyyy-MM-ddmandatory
dateTypetransaction

validation

optional (falls back to "transaction" if not set)
region

currently supported: AT AU BE BR (Brazil programs running in BRL) BU (Brazil programs running in USD) CA CH DE DK ES FI FR GB IE IT NL NO PL SE US

 mandatory
timezone

America/Sao_Paulo Australia/Sydney Europe/Berlin Europe/Dublin Europe/Helsinki Europe/London Europe/Paris Canada/Central Canada/Eastern Canada/Mountain Canada/Pacific US/Central US/Eastern US/Mountain US/Pacific UTC

mandatory 
Responses
200

OK

Expand All
object
body
object
statusCode
string
Valid values[ "\"100 CONTINUE\"", "\"101 SWITCHING_PROTOCOLS\"", "\"102 PROCESSING\"", "\"103 CHECKPOINT\"", "\"200 OK\"", "\"201 CREATED\"", "\"202 ACCEPTED\"", "\"203 NON_AUTHORITATIVE_INFORMATION\"", "\"204 NO_CONTENT\"", "\"205 RESET_CONTENT\"", "\"206 PARTIAL_CONTENT\"", "\"207 MULTI_STATUS\"", "\"208 ALREADY_REPORTED\"", "\"226 IM_USED\"", "\"300 MULTIPLE_CHOICES\"", "\"301 MOVED_PERMANENTLY\"", "\"302 FOUND\"", "\"302 MOVED_TEMPORARILY\"", "\"303 SEE_OTHER\"", "\"304 NOT_MODIFIED\"", "\"305 USE_PROXY\"", "\"307 TEMPORARY_REDIRECT\"", "\"308 PERMANENT_REDIRECT\"", "\"400 BAD_REQUEST\"", "\"401 UNAUTHORIZED\"", "\"402 PAYMENT_REQUIRED\"", "\"403 FORBIDDEN\"", "\"404 NOT_FOUND\"", "\"405 METHOD_NOT_ALLOWED\"", "\"406 NOT_ACCEPTABLE\"", "\"407 PROXY_AUTHENTICATION_REQUIRED\"", "\"408 REQUEST_TIMEOUT\"", "\"409 CONFLICT\"", "\"410 GONE\"", "\"411 LENGTH_REQUIRED\"", "\"412 PRECONDITION_FAILED\"", "\"413 PAYLOAD_TOO_LARGE\"", "\"413 REQUEST_ENTITY_TOO_LARGE\"", "\"414 URI_TOO_LONG\"", "\"414 REQUEST_URI_TOO_LONG\"", "\"415 UNSUPPORTED_MEDIA_TYPE\"", "\"416 REQUESTED_RANGE_NOT_SATISFIABLE\"", "\"417 EXPECTATION_FAILED\"", "\"418 I_AM_A_TEAPOT\"", "\"419 INSUFFICIENT_SPACE_ON_RESOURCE\"", "\"420 METHOD_FAILURE\"", "\"421 DESTINATION_LOCKED\"", "\"422 UNPROCESSABLE_ENTITY\"", "\"423 LOCKED\"", "\"424 FAILED_DEPENDENCY\"", "\"425 TOO_EARLY\"", "\"426 UPGRADE_REQUIRED\"", "\"428 PRECONDITION_REQUIRED\"", "\"429 TOO_MANY_REQUESTS\"", "\"431 REQUEST_HEADER_FIELDS_TOO_LARGE\"", "\"451 UNAVAILABLE_FOR_LEGAL_REASONS\"", "\"500 INTERNAL_SERVER_ERROR\"", "\"501 NOT_IMPLEMENTED\"", "\"502 BAD_GATEWAY\"", "\"503 SERVICE_UNAVAILABLE\"", "\"504 GATEWAY_TIMEOUT\"", "\"505 HTTP_VERSION_NOT_SUPPORTED\"", "\"506 VARIANT_ALSO_NEGOTIATES\"", "\"507 INSUFFICIENT_STORAGE\"", "\"508 LOOP_DETECTED\"", "\"509 BANDWIDTH_LIMIT_EXCEEDED\"", "\"510 NOT_EXTENDED\"", "\"511 NETWORK_AUTHENTICATION_REQUIRED\"" ]
statusCodeValue
integer (int32)

Which data fields do we provide

field namedescription
advertiserIdID of the advertiser/ corresponding with advertiserName
advertiserNameName of the advertiser/ corresponding with advertiserId
publisherIdID of the publisher/ corresponding with publisherName
publisherNameName of the publisher/ corresponding with publisherId
region
currencyISO code
impressionsnumber of impressions
clicksnumber of clicks
pendingNonumber of pending transactions
pendingValuevalue of the pending transactions
pendingCommcommissions of the pending transactions
confirmedNonumber of confirmed transactions
confirmedValuevalue of confirmed transactions
confirmedCommcommission of the confirmed transactions
bonusNonumber of bonus transactions
bonusValuevalue of the bonus transactions
bonusCommcommission of the bonus transactions
totalNototal number of transactions
totalValuevalue of all transactions
totalCommcommission of all transactions
declinedNonumber of declined transactions
declinedValuevalue of declined transactions
declinedCommcommission of declined transactions 

Was this article helpful?